Private Member Functions | List of all members
LayerObject Class Reference

#include <c4d_basedocument.h>

Inheritance diagram for LayerObject:
Inheritance graph
[legend]

Detailed Description

Represents a layer in a document.

Note
Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Private Member Functions

 LayerObject ()
 
 ~LayerObject ()
 

Alloc/Free

static LayerObject * Alloc ()
 
static void Free (LayerObject *&bl)
 

Navigation

LayerObject * GetNext ()
 
LayerObject * GetPred ()
 
LayerObject * GetUp ()
 
LayerObject * GetDown ()
 
LayerObject * GetDownLast ()
 

Additional Inherited Members

- 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)
 
- 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

◆ LayerObject()

LayerObject ( )
private

◆ ~LayerObject()

~LayerObject ( )
private

Member Function Documentation

◆ Alloc()

static LayerObject* Alloc ( )
static

Allocates a layer. Destroy the allocated layer with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Returns
The allocated layer, or nullptr if the allocation failed.

◆ Free()

static void Free ( LayerObject *&  bl)
static

Destructs layers allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in]blThe layer to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ GetNext()

LayerObject* GetNext ( )

Gets the next layer in the list. Convenience version of GeListNode::GetNext() returning a pointer to a LayerObject.

Returns
The next layer, or nullptr if there is none. Cinema 4D owns the pointed layer.

◆ GetPred()

LayerObject* GetPred ( )

Gets the previous layer in the list. Convenience version of GeListNode::GetPred() returning a pointer to a LayerObject.

Returns
The previous layer, or nullptr if there is none. Cinema 4D owns the pointed layer.

◆ GetUp()

LayerObject* GetUp ( )

Gets the parent layer of the list node. Convenience version of GeListNode::GetUp() returning a pointer to a LayerObject.

Returns
The parent layer, or nullptr if there is none. Cinema 4D owns the pointed layer.

◆ GetDown()

LayerObject* GetDown ( )

Gets the first child layer of the list node. Convenience version of GeListNode::GetDown() returning a pointer to a LayerObject.

Returns
The first child layer, or nullptr if there is none. Cinema 4D owns the pointed layer.

◆ GetDownLast()

LayerObject* GetDownLast ( )

Gets the last child layer of the list node. Convenience version of GeListNode::GetDownLast() returning a pointer to a LayerObject.

Returns
The last child layer, or nullptr if there is none. Cinema 4D owns the pointed layer.