BaseList2D Class Reference

#include <c4d_baselist.h>

Inheritance diagram for BaseList2D:

Detailed Description

Represents a C4DAtom that resides in a 2D list.

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
	BaseList2D ()
	~BaseList2D ()

Bit
static const Int32	SETBIT_FLAG_NODIRTY
static const Int32	SETBIT_FLAG_REMOVE
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)

Alloc/Free
static BaseList2D *	Alloc (Int32 type)
static void	Free (BaseList2D *&bl)
const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

Navigation
BaseList2D *	GetNext ()
BaseList2D *	GetPred ()

Container
BaseContainer	GetData ()
void	SetData (const BaseContainer &bc, Bool add=true)
const BaseContainer *	GetDataInstance () const
BaseContainer *	GetDataInstance ()
const BaseContainer &	GetDataInstanceRef () const
BaseContainer &	GetDataInstanceRef ()

Name
String	GetName () const
void	SetName (const maxon::String &name)

Miscellaneous
String	GetBubbleHelp ()
Bool	TransferGoal (BaseList2D *dst, Bool undolink)
Bool	TransferMarker (BaseList2D *dst) const
Bool	Scale (Float scale)
Bool	Edit ()
void	GetIcon (IconData *dat)
GeListHead *	GetNLARoot ()
BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)
String	GetTypeName ()
BaseList2D *	GetMain () const
void	InsertTrackSorted (CTrack *track)
Bool	AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
Bool	RemoveEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool	FindEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const
GeListHead *	GetOverrideRoot ()
BaseOverride *	GetFirstOverride ()
GeListHead *	GetShaderRepositoryRoot ()
GeListHead *	GetHiddenShaderRoot ()
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

Marker
void	GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
const GeMarker &	GetMarker () const
void	SetMarker (const GeMarker &m)

Unique ID
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

Animated Parameter
Bool	SetAnimatedParameter (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)

Shader
BaseShader *	GetFirstShader () const
void	InsertShader (BaseShader *shader, BaseShader *pred=nullptr)

Keyframe
void	ClearKeyframeSelection ()
Bool	FindKeyframeSelection (const DescID &id)
Bool	SetKeyframeSelection (const DescID &id, Bool selection)
Bool	KeyframeSelectionContent ()

Layer
LayerObject *	GetLayerObject (BaseDocument *doc)
Bool	SetLayerObject (LayerObject *layer)
const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)
Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

Track
GeListHead *	GetCTrackRoot ()
CTrack *	GetFirstCTrack ()
CTrack *	FindCTrack (const DescID &id)

Additional Inherited Members
Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()
GeListNode *	GetPred ()
GeListNode *	GetDown ()
GeListNode *	GetUp ()
GeListNode *	GetDownLast ()
void	InsertBefore (GeListNode *bl)
void	InsertAfter (GeListNode *bl)
void	InsertUnder (GeListNode *bl)
void	InsertUnderLast (GeListNode *bl)
void	Remove ()
GeListHead *	GetListHead ()
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 ()
BaseDocument *	GetDocument ()
Int32	GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool	IsDocumentRelated ()
Int32	GetInfo () const
Bool	GetNBit (NBIT bit) const
UInt32	GetNBitMask (Int32 index) const
Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)
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)
Bool	CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool	Read (HyperFile *hf, Int32 id, Int32 level)
Bool	Write (HyperFile *hf)
Bool	ReadObject (HyperFile *hf, Bool readheader)
Bool	WriteObject (HyperFile *hf)
Bool	GetDescription (Description *description, DESCFLAGS_DESC flags)
Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
DynamicDescription *	GetDynamicDescription ()
Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
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)

Constructor & Destructor Documentation

BaseList2D()

BaseList2D ( )

private

~BaseList2D()

~BaseList2D ( )

private

Member Function Documentation

Alloc()

static BaseList2D* Alloc ( Int32  type )

static

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

Parameters

[in]

type

A node type ID.

Free()

static void Free ( BaseList2D *&  bl )

static

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

Parameters

[in,out]

bl

The base list node to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

GetViewportRenderId()

const Char* GetViewportRenderId

(

VIEWPORT_RENDER_ID

typeId

)

const

Gets the Id of the viewport render object. The return value can be nullptr.

Parameters

[in]

typeId

Defines which Id to return.

Returns

The viewport render Id.

GetNext()

BaseList2D* GetNext

(

void

)

Gets the next BaseList2D in the list. Convenience version of GeListNode::GetNext().

Returns

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

GetPred()

BaseList2D* GetPred

(

void

)

Gets the previous BaseList2D in the list. Convenience version of GeListNode::GetPred().

Returns

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

SetBit()

void SetBit

(

Int32

mask

)

Sets the bits denoted by mask to true.

Parameters

[in]

mask

The mask of the bits: BIT

GetBit()

Bool GetBit

(

Int32

mask

)

const

Gets the state of the object bits denoted by mask.

Parameters

[in]

mask

The mask of the bits: BIT

Returns

The state of the object bits denoted by mask.

DelBit()

void DelBit

(

Int32

mask

)

Deletes the object bits denoted by mask, i.e. sets the corresponding bit to 0.

Parameters

[in]

mask

The bit mask of the bits: BIT

ToggleBit()

void ToggleBit

(

Int32

mask

)

Toggles the state of the object bits denoted by the mask.

Parameters

[in]

mask

The bit mask of the bits: BIT

GetAllBits()

Int32 GetAllBits

(

)

const

Returns all the object's bits.

Returns

All the object's bits: BIT

SetAllBits()

void SetAllBits

(

Int32

bits

)

Sets all the object's bits at once.

Parameters

[in]

bits

The new object's bits.

SetBitEx()

void SetBitEx	(	Int32	mask,
		Int32	flags
	)

GetData()

BaseContainer GetData

(

void

)

Retrieves a copy of the object's container.

Note

Some objects do not store all their data in the container. For these use GetParameter()/SetParameter() instead.
Here are some built-in objects that do not store everything in the container:

• CompositingTag
• DisplayTag
• ValueKey
• TextureTag
• KinematicTag
• UVWTag
• LightObject
• MetaballTag

There are also often some other pieces of information that are not stored in the container, for example:

• a BaseList2D's name.
• a CameraObject's FOV (which is used just for display).

Most of this information is accessible through other API functions, like for example BaseList2D::GetName().

Returns

The object container.

SetData()

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

Sets the object container.
By default the contents of bc is added to the existing container; control this behavior with add.

Note

Do not forget to send a message if you change any settings.

Parameters

[in]	bc	The container with the new values.
[in]	add	If false the values are merged, otherwise the old values are discarded.

GetDataInstance() [1/2]

const BaseContainer* GetDataInstance

(

void

)

const

Retrieves a pointer to the read-only object container.

See also

GetData()

Returns

A pointer to the read-only internal container. The node owns the pointed container.

Note

The returned pointer is guaranteed to be valid and never nullptr.

GetDataInstance() [2/2]

BaseContainer* GetDataInstance

(

void

)

Retrieves a pointer to the object container that can be changed directly.

See also

GetData()

Returns

A pointer to the internal container. The node owns the pointed container.

Note

The returned pointer is guaranteed to be valid and never nullptr.

GetDataInstanceRef() [1/2]

const BaseContainer& GetDataInstanceRef

(

)

const

Retrieves a reference to the read-only object container.

Since

R19

See also

GetData()

Returns

A reference to the read-only internal container. The node owns the referenced container.

GetDataInstanceRef() [2/2]

BaseContainer& GetDataInstanceRef

(

)

Retrieves a reference to the object container that can be changed directly.

Since

R19

See also

GetData()

Returns

A reference to the internal container. The node owns the referenced container.

GetName()

String GetName

(

)

const

Gets the name of the object.

Returns

The object's name.

SetName()

void SetName

(

const maxon::String &

name

)

Sets the name of the object.

Parameters

[in]

name

The new object's name.

GetBubbleHelp()

String GetBubbleHelp

(

)

Gets the bubble help text for the object.

Returns

The bubble help text.

TransferGoal()

Bool TransferGoal	(	BaseList2D *	dst,
		Bool	undolink
	)

Transfer goals from the object to dst.
This changes all BaseLink links that point to this object to point to dst instead.

Parameters

[in]	dst	The destination. The caller owns the pointed object.
[in]	undolink	This has to be set to false. Private.

Returns

true if the goals could be transfered, otherwise false.

TransferMarker()

Bool TransferMarker

(

BaseList2D *

dst

)

const

Private.

GetMarkerStampEx()

void GetMarkerStampEx	(	UInt32 *	l1,
		UInt32 *	l2
	)

Deprecated.

GetMarker()

const GeMarker& GetMarker

(

)

const

Gets the object's marker.

Returns

The object's marker.

SetMarker()

void SetMarker

(

const GeMarker &

m

)

Sets the object's marker.

Parameters

[in]

m

The new object's marker.

AddUniqueID()

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

Adds a unique application ID data to the object.

Note

This is used for instance to identify scenes written by external applications.

Parameters

[in]	appid	A unique application ID. It has to be registered at MAXON, at least it should be obtained from http://www.plugincafe.com.
[in]	mem	A pointer to a block of memory, used for instance to store the name of a software vendor.
[in]	bytes	The length of the memory block mem.

Returns

true if successful, otherwise false.

FindUniqueID()

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

Checks for a specific unique application ID data.

Note

This is used for instance to identify scenes written by external applications.

Parameters

[in]	appid	A unique application ID. It has to be registered at MAXON, at least it should be obtained from http://www.plugincafe.com.
[out]	mem	Assigned a pointer to a block of memory, used for instance to read the name of a software vendor.
[out]	bytes	Assigned the length of the memory block mem.

Returns

true if the ID could be found, otherwise false.

GetUniqueIDCount()

Int32 GetUniqueIDCount

(

)

const

Gets the number of unique application IDs.

Returns

The number of unique application IDs.

GetUniqueIDIndex()

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

Gets the idx-th unique application ID data (idx ranging from 0 to GetUniqueIDCount()-1).

Note

This is used for instance to identify scenes written by external applications.

Parameters

[in]	idx	The unique ID index.
[out]	id	Assigned the unique application ID.
[out]	mem	Assigned a pointer to a block of memory, used for instance to read the name of a software vendor.
[out]	bytes	Assigned the length of the memory block mem.

Returns

true if successful, otherwise false.

SetAnimatedParameter()

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

Normally not used. Used by the animator to set the interpolated value along with the right and left value.

Parameters

[in]	track	The animation track. The caller owns the pointed track.
[in]	id	The ID of the animated parameter.
[in]	t_data1	The first data.
[in]	t_data2	The second data.
[in]	mix	The mix value between t_data1 and t_data2.
[in]	flags	Flags: DESCFLAGS_SET

Returns

true if the animated parameter was set, otherwise false.

GetAnimatedParameter()

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

If a parameter is set to MIX animation use this function to retrieve information about it.
For example, the target expression has a link to its current target and when it is animated it slides between the two targets:

EXECUTIONRESULT TargetExpressionTag::Execute(BaseTag* tag, BaseDocument* doc, BaseObject* op, BaseThread* bt, Int32 priority, EXECUTIONFLAGS flags)
{
  GeData s1, s2;
  Float mix;
 
  tag->GetAnimatedParameter(DescLevel(TARGETEXPRESSIONTAG_LINK), s1, s2, mix, DESCFLAGS_GET::NONE);
 
  BaseList2D *o1 = s1.GetLink(doc);
  BaseList2D *o2 = s2.GetLink(doc);
 
  if (!o1 || !o1->IsInstanceOf(Obase))
    return EXECUTIONRESULT::OK;
 
  Vector nrot, p = ((BaseObject*)o1)->GetMg().off;
 
  if (mix>0.0 && o2 && o2->IsInstanceOf(Obase))
    p = p * (1.0-mix) + ((BaseObject*)o2)->GetMg().off * mix;
 
  p = p * (!op->GetUpMg());
 
  nrot = VectorToHPB(p - op->GetPos());
  nrot.z = op->GetRot().z;
  op->SetRot(nrot);
 
  return EXECUTIONRESULT::OK;
}

Parameters

[in]	id	The ID of the parameter.
[in]	t_data1	Assigned the first data.
[in]	t_data2	Assigned the second data.
[in]	mix	Assigned the mix value between t_data1 and t_data2.
[in]	flags	Flags: DESCFLAGS_GET

Returns

true if the animated parameter was retrieved, otherwise false.

Scale()

Bool Scale

(

Float

scale

)

Sets the object's scale.
This will scale all parameters with length units by the factor scale.

Parameters

[in]

scale

The scale factor.

Returns

true if the object was scaled successfully, otherwise false.

GetFirstShader()

BaseShader* GetFirstShader

(

)

const

Retrieves the first shader of the object.

Note

Normally you do not have to deal with the shader list. But if you want to create or modify shader trees via the API read the following lines:
If you are programming shader links to make sure that every shader is referenced only once; it is not allowed that a shader is referenced multiple times.
If the referencing object is a shader the referenced shader must be child of it, otherwise it must be inserted via InsertShader().

Example 1: A tag references a shader. The shader must be inserted into the tag using InsertShader();. Example 2: A Shader (A) references another shader (B): the shader B must be child of the shader A.

Returns

The first shader of the object, or nullptr if there are none. The object owns the pointed shader.

InsertShader()

void InsertShader	(	BaseShader *	shader,
		BaseShader *	pred = nullptr
	)

Inserts a shader in the object's shader list.

BaseMaterial *mat = nullptr;
mat = doc->GetFirstMaterial();
if (!mat)
  return true;
 
BaseContainer *data = mat->GetDataInstance();
if (!data)
  return true;
 
BaseShader *shd = BaseShader::Alloc(Xbitmap);
if (!shd)
  return false;
 
data->SetLink(MATERIAL_COLOR_SHADER, shd);
mat->InsertShader(shd);
mat->Message(MSG_UPDATE);
mat->Update(true, true);
 
EventAdd();

Parameters

[in]	shader	The shader to insert. The object takes over the ownership of the pointed shader.
[in]	pred	The shader to insert the new shader after, or nullptr (default)to insert the new shader first. The pointed shader must already be inserted into the list.

Edit()

Bool Edit

(

)

Triggers the edit action for the object.

Note

For most types this brings up the node in the attributes manager. Some still show a separate dialog.

Returns

true if successful, otherwise false.

GetIcon()

void GetIcon

(

IconData *

dat

)

Gets the icon for the object, by filling dat.

Parameters

[out]

dat

Pointer to the icon data to fill. The caller owns the pointed icon data.

ClearKeyframeSelection()

void ClearKeyframeSelection

(

)

Clears the current keyframe selection.

FindKeyframeSelection()

Bool FindKeyframeSelection

(

const DescID &

id

)

Checks if id is included in the keyframe selection.

Parameters

[in]

id

The description ID to check.

Returns

true if the given id is selected, otherwise false.

SetKeyframeSelection()

Bool SetKeyframeSelection	(	const DescID &	id,
		Bool	selection
	)

Sets the keyframe selection status of id to selection.

Parameters

[in]	id	The description ID to set.
[in]	selection	true if the element should be included in the keyframe selection, otherwise false.

Returns

A value that should be ignored.

KeyframeSelectionContent()

Bool KeyframeSelectionContent

(

)

Checks if there is any active keyframe selections.

Note

This is not the same as BIT_ACTIVE; it is the possibility to restrict auto-keyframing to certain description parameters.
See "Animation->Add Keyframe Selection" in the Attribute Manager.

Returns

true if there is a keyframe selection, otherwise false.

GetLayerObject()

LayerObject* GetLayerObject

(

BaseDocument *

doc

)

Gets the layer of the object.

Parameters

[in]

doc

The document for the operation.

Returns

The layer, or nullptr.

SetLayerObject()

Bool SetLayerObject

(

LayerObject *

layer

)

Sets the layer of the object.

Parameters

[in]

layer

The new layer.

Returns

true if the layer was successfully set, otherwise false.

GetLayerData()

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

Gets the layer data for the object.

Parameters

[in]	doc	The document for the operation.
[in]	rawdata	Usually GetLayerData() takes special global modes like SOLO layer automatically into account. To get the original layer values without any additional global changes set rawdata to true.

Returns

The layer data, or nullptr.

SetLayerData()

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

Sets the layer data for the object.

Parameters

[in]	doc	The document for the operation.
[in]	data	The new layer data.

Returns

true if the layer data was successfully set, otherwise false.

GetCTrackRoot()

GeListHead* GetCTrackRoot

(

)

Gets the track root of the object.

Returns

The track root.

GetFirstCTrack()

CTrack* GetFirstCTrack

(

)

Gets the first track of the object.

Returns

The first track, or nullptr if there are no tracks.

FindCTrack()

CTrack* FindCTrack

(

const DescID &

id

)

Finds the track for the specified description id.

Parameters

[in]

id

The description ID for the searched track.

Returns

The found track, or nullptr if there was no match.

GetNLARoot()

GeListHead* GetNLARoot

(

)

Private.

AnimationLayerRemap()

BaseList2D* AnimationLayerRemap

(

BaseObject **

layer = nullptr

)

Retrieves a remapped base list pointer if an active animation layer is existent.
If there is no active layer or no layer at all this will be returned.
Optionally access the layer by passing layer.

Parameters

[out]

layer

The current active layer. You can then access the layer properties. Cinema 4D owns the pointed layer object.

Returns

The remapped base list pointer. This is the object of the current active layer. Cinema 4D owns the pointed layer object.

GetTypeName()

String GetTypeName

(

)

The name of the object type, for example "Phong", "Spline", "Bone", etc.

Returns

The type name.

GetMain()

BaseList2D* GetMain

(

)

const

Goes up the next level, e.g. from tag to object or XPresso node to tag, or object to document, etc.

Returns

The main object of the object.

InsertTrackSorted()

void InsertTrackSorted

(

CTrack *

track

)

Inserts a track and automatically places it at the right place (so that Y comes after X for example).

Parameters

[in]

track

The track to insert.

AddEventNotification()

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

Private.

RemoveEventNotification()

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

Private.

FindEventNotification()

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

Private.

SetDescIDState()

Bool SetDescIDState	(	const DescID &	id,
		DESCIDSTATE	descidstate
	)

Sets the state for the description id.

Parameters

[in]	id	The description ID.
[in]	descidstate	The new description ID state: DESCIDSTATE

Returns

true if the description ID state was successfully set, otherwise false.

GetDescIDState()

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

Gets the state of a description id.

Parameters

[in]	id	The description ID.
[in]	tolerant	If set to true a valid state is returned even though the description ID do not match-completly. This can be useful for descriptions with several levels. Take this description ID for example: DescID(DescLevel(1000, DTYPE_VECTOR, 0), DescLevel(1, DTYPE_REAL, 0)) If tolerant is true a valid state is returned even though only the following description ID is passed: DescID(DescLevel(1000, DTYPE_VECTOR, 0))

Returns

The description ID state: DESCIDSTATE

GetOverrideRoot()

GeListHead* GetOverrideRoot

(

)

Private.

Since

R17.032

GetFirstOverride()

BaseOverride* GetFirstOverride

(

)

Private.

Since

R17.032

GetShaderRepositoryRoot()

GeListHead* GetShaderRepositoryRoot

(

)

Private.

Since

R17.032

GetHiddenShaderRoot()

GeListHead* GetHiddenShaderRoot

(

)

Private.

GetNimbusRef()

maxon::NimbusForwardRef GetNimbusRef

(

const maxon::Id &

spaceId

)

const

Return the owning NimbusRef or NimbusBaseRef corresponding to the provided NodeSpace Id.

// Retrieve the standard render NodeSpace from the selected material. In practice we should
// test if mat is a nullptr before proceeding.
BaseMaterial* mat = doc->GetActiveMaterial();
maxon::NimbusBaseRef nimbusRef = mat->GetNimbusRef(maxon::nodes::MaterialNodeSpaces::Standard.GetId());
if (nimbusRef == nullptr)
  return;

Parameters

[in]

spaceId

The NodeSpace ID.

Returns

Returns the owner of the node graph.

PrivateGetOrCreateNimbusRef()

maxon::Result<maxon::NimbusForwardRef> PrivateGetOrCreateNimbusRef

(

const maxon::Id &

spaceId

)

Private.

RemoveNimbusRef()

void RemoveNimbusRef

(

const maxon::Id &

spaceId

)

Remove the NimbusRef, and therefor the owned graph, that is corresponding to the provided NodeSpace Id.

Parameters

[in]

spaceId

The NodeSpace ID.

GetAllNimbusRefs()

maxon::Result<maxon::HashMap<maxon::Id, maxon::NimbusForwardRef> > GetAllNimbusRefs

(

)

const

Retrieve a HashMap of all NodeSpace ID and NimbusRef of the current BaseList is holding.

Note

The NimbusForwardRef cannot be casted directly to a maxon::NimbusBaseRef. Instead, maxon::NimbusForwardRef::GetBase should be used to retrieve the base.

// Print all the NodeSpace ID from the selected material. In practice we should
  // test if mat is a nullptr before proceeding.
BaseMaterial* mat = doc->GetActiveMaterial();
// The error handling needs to have an error context defined with either iferr_scope or iffer_handler.
const maxon::HashMap<maxon::Id, maxon::NimbusForwardRef> hashNimbusRefs = mat->GetAllNimbusRefs() iferr_return;
for (const auto& e : hashNimbusRefs)
{
  const maxon::Id& key = e.GetKey();
  const maxon::NimbusBaseRef nimbusRef = e.GetValue().GetBase();
  ApplicationOutput("NodeSpace ID: @"_s, key);
}

Returns

Returns a hash map of NodeSpace ID with their corresponding NimbusRef.

IsNodeBased()

Bool IsNodeBased

(

)

const

Checks whether the object contains nodes.

Returns

True if node-based.

Member Data Documentation

SETBIT_FLAG_NODIRTY

const Int32 SETBIT_FLAG_NODIRTY

static

Private.

SETBIT_FLAG_REMOVE

const Int32 SETBIT_FLAG_REMOVE

static