#include <lib_sculpt.h>

Inheritance diagram for SculptLayer:

[legend]

Detailed Description

A sculpt layer can contain one or more SculptLayerData children.

Public Member Functions
SculptLayerData *	GetFirstSculptLayerData ()

SculptLayerData *	GetCurrentSculptLayerData ()

Int32	GetPointCount ()

Bool	GetOffset (Int32 index, Vector &offset)

void	SetOffset (Int32 index, const Vector &fullOffset)

void	AddOffset (Int32 index, const Vector &offset)

Bool	GetMask (Int32 index, Float32 &mask)

void	SetMask (Int32 index, Float32 mask)

void	AddToMask (Int32 index, Float32 mask)

void	ClearMask ()

void	ClearLayer ()

void	InitializeAllPointData ()

void	InitializeAllMaskData ()

void	TouchPointForUndo (Int32 index)

void	TouchMaskForUndo (Int32 index)

Bool	IsBaseLayer ()

Bool	HasMask ()

Bool	IsMaskEnabled ()

void	SetMaskEnabled (Bool value)

Public Member Functions inherited from SculptLayerBase
Bool	Select ()

Bool	IsVisible ()

void	SetVisible (Bool value)

Bool	IsLocked ()

void	SetLocked (Bool value)

Float	GetStrength ()

void	SetStrength (Float value)

Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)

Bool	GetBit (Int32 mask) const

void	DelBit (Int32 mask)

void	ToggleBit (Int32 mask)

Int32	GetAllBits () const

void	SetAllBits (Int32 bits)

void	SetBitEx (Int32 mask, Int32 flags)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

const BaseList2D *	GetNext () const

BaseList2D *	GetPred ()

const BaseList2D *	GetPred () const

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

String	GetName () const

void	SetName (const maxon::String &name, Bool setDirty=true)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot (Bool create)

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName () const

const BaseList2D *	GetMain () const

BaseList2D *	GetMain ()

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot (Bool create)

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot (Bool create)

GeListHead *	GetHiddenShaderRoot (Bool create)

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

maxon::Result< Bool >	GetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< maxon::GenericData >	GroupChanges ()

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () const

void	SetMarker (const GeMarker &m)

Bool	AddUniqueID (Int32 appid, const Char *const mem, Int bytes)

Bool	FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const

Int32	GetUniqueIDCount () const

Bool	GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const

Bool	SetAnimatedParameter (const CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)

Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags) const

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (const BaseDocument *doc)

const LayerObject *	GetLayerObject (const BaseDocument *doc) const

Bool	SetLayerObject (const LayerObject *layer)

const LayerData *	GetLayerData (const BaseDocument *doc, Bool rawdata=false) const

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot (Bool create)

const GeListHead *	GetCTrackRoot () const

const CTrack *	GetFirstCTrack () const

CTrack *	GetFirstCTrack ()

const CTrack *	FindCTrack (const DescID &id) const

CTrack *	FindCTrack (const DescID &id)

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

const GeListNode *	GetNext () const

GeListNode *	GetPred ()

const GeListNode *	GetPred () const

GeListNode *	GetDown ()

const GeListNode *	GetDown () const

GeListNode *	GetUp ()

const GeListNode *	GetUp () const

GeListNode *	GetDownLast ()

const GeListNode *	GetDownLast () const

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

void	FlushChilds ()

void	MoveChildrenTo (GeListNode *dest)

GeListHead *	GetListHead ()

const GeListHead *	GetListHead () const

Int32	GetNodeID (Int32 index=0) const

template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const

template<typename CAST >
CAST *	GetNodeData (Int32 index=0)

void	SetCustomData (GeListNode *node)

GeListNode *	GetCustomData ()

const GeListNode *	GetCustomData () const

const BaseDocument *	GetDocument () const

BaseDocument *	GetDocument ()

maxon::Result< Bool >	GetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const

Bool	IsDocumentRelated () const

Int32	GetInfo () const

Bool	GetNBit (NBIT bit) const

UInt32	GetNBitMask (Int32 index) const

Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)

Public Member Functions inherited from C4DAtomGoal
Bool	HasLinks () const

Public Member Functions inherited from C4DAtom
Int32	GetType () const

Int32	GetRealType () const

Int32	GetDiskType () const

Bool	IsInstanceOf (Int32 id) const

Int32	GetClassification () const

Bool	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn) const

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn) const

Bool	Read (HyperFile *hf, Int32 id, Int32 level)

Bool	Write (HyperFile *hf) const

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf) const

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags) const

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags) const

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescriptionWritable ()

const DynamicDescription *	GetDynamicDescription () const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const

Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)

UInt32	GetDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

UInt32	GetHDirty (HDIRTYFLAGS mask) const

void	SetHDirty (HDIRTYFLAGS mask)

Private Member Functions
	SculptLayer ()

	~SculptLayer ()

Additional Inherited Members
Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)

static void	Free (BaseList2D *&bl)

Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ SculptLayer()

SculptLayer ( )

private

◆ ~SculptLayer()

~SculptLayer ( )

private

Member Function Documentation

◆ GetFirstSculptLayerData()

SculptLayerData* GetFirstSculptLayerData ( )

Gets the first layer data for the layer.

Note: The Base layer has more than 1, other layers only have 1.

Returns: The first layer data.

◆ GetCurrentSculptLayerData()

SculptLayerData* GetCurrentSculptLayerData ( )

Gets the currently used layer data.

Note: In the case of the Base layer it returns the data for the current subdivision level.
For all other layers it returns the same as GetFirstSculptLayerData().

Returns: The currently used layer data.

◆ GetPointCount()

Int32 GetPointCount ( )

Gets the number of points the layer has.

Note: The point count is the same as the number of points on the PolygonObject for the subdivision level that this layer is at.

Returns: The number of points.

◆ GetOffset()

Bool GetOffset	(	Int32	index,
		Vector &	offset
	)

Gets the offset value for the point at index on the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Parameters

[in]	index	The index of the point on the layer: 0 <= index < GetPointCount()
[out]	offset	Assigned the offset.

Returns: true if there was offset data for the point. false if no offset data was allocated for the point.

◆ SetOffset()

void SetOffset	(	Int32	index,
		const Vector &	fullOffset
	)

Sets the offset Vector for the given point at index on the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Warning: Be sure to call SculptObject::Update() after all changes to the offsets have been made. This will update the SculptObject display.
Also call SculptObject::UpdateCollision() if any of the SculptObject::Hit() methods is used aftewards.
If this method is called from multiple threads then be sure to call InitializeAllPointData() before.

Parameters

[in]	index	The index of the point on the layer: 0 <= index < GetPointCount()
[in]	fullOffset	The offset vector to set.

◆ AddOffset()

void AddOffset	(	Int32	index,
		const Vector &	offset
	)

Adds an offset Vector to the existing offset for the given point at index on the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Warning: Be sure to call SculptObject::Update() after all changes to the offsets have been made. This will update the SculptObject display.
Also call SculptObject::UpdateCollision() if any of the SculptObject::Hit() methods is used aftewards.
If this method is called from multiple threads then be sure to call InitializeAllPointData() before.

Parameters

[in]	index	The index of the point on the layer: 0 <= index < GetPointCount()
[in]	offset	The offset vector to add.

◆ GetMask()

Bool GetMask	(	Int32	index,
		Float32 &	mask
	)

Gets the mask value for the given point at index on the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Parameters

[in]	index	The index of the point on the layer: 0 <= index < GetPointCount()
[out]	mask	Assigned the mask value for the point. The value is between 0 and 1 where 0 means no mask and 1 fully masked.

Returns: true if there was mask data for the point. false if no mask data was allocated for the point.

◆ SetMask()

void SetMask	(	Int32	index,
		Float32	mask
	)

Sets the mask value for the given point at index on the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Warning: If this method is called from multiple threads then be sure to call InitializeAllPointData() before.

Parameters

[in]	index	The index of the point on the layer: 0 <= index < GetPointCount()
[in]	mask	The mask value to set. The value will be clamped between 0 and 1; 0 means no mask and 1 fully masked.

◆ AddToMask()

void AddToMask	(	Int32	index,
		Float32	mask
	)

Adds to the existing mask value for the given point at index on the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Warning: If this method is called from multiple threads then be sure to call InitializeAllMaskData() before.

Parameters

[in]	index	The index of the point on the layer: 0 <= index < GetPointCount()
[in]	mask	The value to add to the mask. The value will be clamped between 0 and 1; 0 means no mask and 1 fully masked.

◆ ClearMask()

void ClearMask ( )

Clears the mask data for the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

◆ ClearLayer()

void ClearLayer ( )

Clears all the offset data for the layer.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

◆ InitializeAllPointData()

void InitializeAllPointData ( )

Makes sure all the data has been allocated to store the point data.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.
If SetOffset() or AddOffset() are called from multiple threads then the data needs to be initialized before these calls are made.
If multiple threads are not used the calls to SetOffset() and AddOffset() will only allocate data if required.

◆ InitializeAllMaskData()

void InitializeAllMaskData ( )

Makes sure all the data has been allocated to store the mask data.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.
If SetMask() or AddToMask() are called from multiple threads then the data needs to be initialized before these calls are made.
If multiple threads are not used the calls to SetMask() and AddToMask() will only allocate data if required.

◆ TouchPointForUndo()

void TouchPointForUndo ( Int32 index )

Marks the point at index so that any modifications to it can be undone.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Warning: Must be called after SculptObject::StartUndo().
This method can not be called from multiple threads.

Parameters

[in] index The index of the point on the layer: 0 <= index < GetPointCount()

◆ TouchMaskForUndo()

void TouchMaskForUndo ( Int32 index )

Marks the masked point index so that any modifications it can be undone.

Note: This method gets the correct SculptLayerData for the layer and call the corresponding method for it.

Warning: Must be called after SculptObject::StartUndo().
This method can not be called from multiple threads.

Parameters

[in] index The index of the point on the layer: 0 <= index < GetPointCount()

◆ IsBaseLayer()

Bool IsBaseLayer ( )

Checks if the layer is the Base layer in which case it will have more than one ScultLayerData children.

Returns: true if the layer is the Base layer, false if it is a regular layer.

◆ HasMask()

Bool HasMask ( )

Checks if the layer has a mask at the current subdivision level.

Note: This method gets the correct SculptLayerData for this layer and call the corresponding method for it.

Returns: true if there is mask data, otherwise false.

◆ IsMaskEnabled()

Bool IsMaskEnabled ( )

Checks if the mask is enabled for the layer at the current subdivision level.

Returns: true if mask is enabled, otherwise false.

◆ SetMaskEnabled()

void SetMaskEnabled ( Bool value )

Sets the mask enabled state for the layer at the current subdivision level.

Parameters

[in] value The state of the mask.

Detailed Description

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SculptLayer()

◆ ~SculptLayer()

Member Function Documentation

◆ GetFirstSculptLayerData()

◆ GetCurrentSculptLayerData()

◆ GetPointCount()

◆ GetOffset()

◆ SetOffset()

◆ AddOffset()

◆ GetMask()

◆ SetMask()

◆ AddToMask()

◆ ClearMask()

◆ ClearLayer()

◆ InitializeAllPointData()

◆ InitializeAllMaskData()

◆ TouchPointForUndo()

◆ TouchMaskForUndo()

◆ IsBaseLayer()

◆ HasMask()

◆ IsMaskEnabled()

◆ SetMaskEnabled()