InstanceObject Class Reference

#include <lib_instanceobject.h>

Inheritance diagram for InstanceObject:

Detailed Description

Class that contains the minimal data to represent one or multiple instances of an object. This InstanceObject has two modes : single-instance mode or multi-instance mode.

Since
R20

Private Member Functions

 InstanceObject ()
 
 ~InstanceObject ()
 

Alloc/Free

static InstanceObjectAlloc ()
 
static void Free (InstanceObject *&bl)
 

Viewport helper. Internal Use only.

Private.

static void UpdateInstanceList (BaseObject *pObj, InstanceObjectList *pCurrent, InstanceObjectList *&pList, const Matrix &m, const void *instanceCRC=nullptr)
 
static void RecurseGenList (BaseObject *op, BaseObject *generator, HierarchyHelp *hh=nullptr)
 
maxon::Result< void > AddCacheInstanceData (InstanceObjectList *&pList)
 

Multi-instance reference object.

BaseObjectGetReferenceObject (BaseDocument *doc) const
 
maxon::Result< void > SetReferenceObject (BaseObject *refObj)
 

Multi-instance matrix and instance count management.

Bool IsMultiInstance () const
 
maxon::Result< void > SetInstanceMatrices (const maxon::BaseArray< Matrix > &matrices)
 
const maxon::BaseArray< Matrix > * GetInstanceMatrices () const
 
Matrix GetInstanceMatrix (UInt index) const
 
maxon::Result< void > SetInstanceMatrix (UInt index, const Matrix &globalMatrix)
 
UInt32 GetMatrixDirtyID (UInt index) const
 
UInt GetInstanceCount () const
 

Multi-instance color accessors.

maxon::Result< void > SetInstanceColors (const maxon::BaseArray< maxon::Color64 > &colors)
 
const maxon::BaseArray< maxon::Color64 > * GetInstanceColors () const
 
maxon::Color64 GetInstanceColor (UInt index) const
 

Multi-instance unique IP accessors.

maxon::Result< void > SetInstanceUniqueIPs (const maxon::BaseArray< Int32 > &uniqueIPs)
 
const maxon::BaseArray< Int32 > * GetInstanceUniqueIPs () const
 
Int32 GetInstanceUniqueIP (UInt index) const
 

Additional Inherited Members

- Public Member Functions inherited from BaseObject
BaseObjectGetNext (void)
 
BaseObjectGetPred (void)
 
BaseObjectGetUp (void)
 
BaseObjectGetDown (void)
 
BaseObjectGetDownLast (void)
 
Vector GetAbsPos () const
 
void SetAbsPos (const Vector &v)
 
Vector GetAbsScale () const
 
void SetAbsScale (const Vector &v)
 
Vector GetAbsRot () const
 
void SetAbsRot (const Vector &v)
 
Vector GetFrozenPos () const
 
void SetFrozenPos (const Vector &v)
 
Vector GetFrozenScale () const
 
void SetFrozenScale (const Vector &v)
 
Vector GetFrozenRot () const
 
void SetFrozenRot (const Vector &v)
 
Vector GetRelPos () const
 
void SetRelPos (const Vector &v)
 
Vector GetRelScale () const
 
void SetRelScale (const Vector &v)
 
Vector GetRelRot () const
 
void SetRelRot (const Vector &v)
 
const MatrixGetMl (void) const
 
void SetMl (const Matrix &m)
 
Matrix GetFrozenMln () const
 
Matrix GetRelMln () const
 
Matrix GetRelMl () const
 
void SetRelMl (const Matrix &m)
 
Matrix GetMg () const
 
void SetMg (const Matrix &m)
 
Matrix GetMln () const
 
Matrix GetMgn () const
 
Matrix GetUpMg () const
 
void CopyMatrixTo (BaseObject *dst)
 
Vector GetMp (void)
 
Vector GetRad (void)
 
Int32 GetEditorMode (void) const
 
void SetEditorMode (Int32 mode)
 
Int32 GetRenderMode (void) const
 
void SetRenderMode (Int32 mode)
 
Bool GetDeformMode (void) const
 
void SetDeformMode (Bool mode)
 
Int32 GetRealDeformMode (void) const
 
void SetRealDeformMode (Int32 mode)
 
Int32 GetUniqueIP (void)
 
void SetUniqueIP (Int32 ip)
 
BaseTagGetFirstTag (void)
 
BaseTagGetLastTag (void)
 
BaseTagGetTag (Int32 type, Int32 nr=0)
 
const maxon::BaseArray< BaseTag * > * GetTagsOfType (Int32 type) const
 
const maxon::BaseArray< BaseTag * > * GetTagsWithFlags (Int32 flags) const
 
const void * GetTagDataR (Int32 type, Int32 nr=0) const
 
void * GetTagDataW (Int32 type, Int32 nr=0)
 
Int32 GetTagDataCount (Int32 type) const
 
BaseTagMakeTag (Int32 type, BaseTag *pred=nullptr)
 
VariableTagMakeVariableTag (Int32 type, Int32 count, BaseTag *pred=nullptr)
 
void InsertTag (BaseTag *tp, BaseTag *pred=nullptr)
 
void KillTag (Int32 type, Int32 nr=0)
 
Bool CopyTagsTo (BaseObject *dest, Int32 visible, Int32 variable, Int32 hierarchical, AliasTrans *trans)
 
BaseObjectGetCache (HierarchyHelp *hh=nullptr)
 
BaseObjectGetDeformCache (void)
 
LineObjectGetIsoparm (void)
 
void SetIsoparm (LineObject *l)
 
BaseObjectGetCacheParent (void) const
 
BaseObjectGetCacheTopParent (void) const
 
Bool SetPhong (Bool on, Bool anglelimit, Float angle)
 
Bool IsDirty (DIRTYFLAGS flags)
 
void SetDirty (DIRTYFLAGS flags)
 
Bool CheckCache (HierarchyHelp *hh)
 
void Touch (void)
 
void GetColorProperties (ObjectColorProperties *prop)
 
void SetColorProperties (ObjectColorProperties *prop)
 
const MatrixGetModelingAxis (BaseDocument *doc)
 
void SetModelingAxis (const Matrix &m)
 
BaseObjectGetAndCheckHierarchyClone (HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, Bool allchildren)
 
BaseObjectGetHierarchyClone (HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans)
 
BaseObjectGetHierarchyClone (HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, DIRTYFLAGS dirtyflags)
 
void NewDependenceList (void)
 
Bool CompareDependenceList (void)
 
void AddDependence (HierarchyHelp *hh, BaseObject *op)
 
void AddDependence (HierarchyHelp *hh, BaseObject *op, DIRTYFLAGS dirtyflags)
 
void TouchDependenceList (void)
 
void SetRotationOrder (ROTATIONORDER order)
 
ROTATIONORDER GetRotationOrder (void) const
 
void SetQuaternionRotationMode (Bool active, Bool bUndo)
 
Bool IsQuaternionRotationMode (void)
 
Bool SynchronizeVectorTrackKeys (Int32 vectorTrackID, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))
 
Bool FindBestEulerAngle (Int32 rotationTrackID, Bool bAdjustTangent, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))
 
Bool EvaluateSynchronizedRotation (const BaseTime &time, ANIMATEFLAGS flags, Vector *resultRotation=nullptr)
 
Bool GetVectorTracks (const DescID &id, CTrack *&xfound, CTrack *&yfound, CTrack *&zfound)
 
Bool GetVectorCurves (CCurve *curveToSearch, CCurve *&xfound, CCurve *&yfound, CCurve *&zfound)
 
UInt64 GetGUID ()
 
Int32 GetHighlightHandle (BaseDraw *bd)
 
SplineObjectGetRealSpline (void)
 
Float GetVisibility (Float parent)
 
Bool SearchHierarchy (BaseObject *op)
 
BaseObjectGetOrigin (Bool safe)
 
void SetOrigin (BaseObject *origin)
 
BaseObjectGetTopOrigin (Bool parent, Bool safe)
 
BaseObjectGetEditObject (BaseObject **psds, DISPLAYEDITSTATE state, Bool safetey=true)
 
void RemoveFromCache (void)
 
DRAWRESULT ObjDraw (DRAWPASS drawpass, BaseDraw *bd, BaseDrawHelp *bh)
 
- Public Member Functions inherited from BaseList2D
const CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
 
BaseList2DGetNext ()
 
BaseList2DGetPred ()
 
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)
 
BaseContainer GetData ()
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance () const
 
BaseContainerGetDataInstance ()
 
const BaseContainerGetDataInstanceRef () const
 
BaseContainerGetDataInstanceRef ()
 
String GetName () const
 
void SetName (const maxon::String &name)
 
String GetBubbleHelp ()
 
Bool TransferGoal (BaseList2D *dst, Bool undolink)
 
Bool TransferMarker (BaseList2D *dst) const
 
Bool Scale (Float scale)
 
Bool Edit ()
 
void GetIcon (IconData *dat)
 
GeListHeadGetNLARoot ()
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
String GetTypeName ()
 
BaseList2DGetMain () 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
 
GeListHeadGetOverrideRoot ()
 
BaseOverrideGetFirstOverride ()
 
GeListHeadGetShaderRepositoryRoot ()
 
GeListHeadGetHiddenShaderRoot ()
 
maxon::NimbusInterface * GetNimbusRef (const maxon::Id &spaceId) const
 
maxon::Result< maxon::NimbusInterface * > GetOrCreateNimbusRef (const maxon::Id &spaceId)
 
void RemoveNimbusRef (const maxon::Id &spaceId)
 
maxon::Result< maxon::HashMap< maxon::Id, maxon::ForwardRef< maxon::NimbusRef > > > GetAllNimbusRefs () const
 
Bool IsNodeBased () const
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
const GeMarkerGetMarker () 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 (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)
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot ()
 
CTrackGetFirstCTrack ()
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
 
GeListNodeGetPred ()
 
GeListNodeGetDown ()
 
GeListNodeGetUp ()
 
GeListNodeGetDownLast ()
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove ()
 
GeListHeadGetListHead ()
 
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)
 
GeListNodeGetCustomData ()
 
BaseDocumentGetDocument ()
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated ()
 
Int32 GetInfo ()
 
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)
 
C4DAtomGetClone (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)
 
DynamicDescriptionGetDynamicDescription ()
 
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)
 
- Static Public Member Functions inherited from BaseObject
static BaseObjectAlloc (Int32 type)
 
static void Free (BaseObject *&bl)
 
- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (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

◆ InstanceObject()

InstanceObject ( )
private

◆ ~InstanceObject()

~InstanceObject ( )
private

Member Function Documentation

◆ Alloc()

static InstanceObject* Alloc ( )
static

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

Returns
The allocated ObjectInstance object, or nullptr if the allocation failed.

◆ Free()

static void Free ( InstanceObject *&  bl)
static

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

Parameters
[in,out]blThe ObjectInstance object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ UpdateInstanceList()

static void UpdateInstanceList ( BaseObject pObj,
InstanceObjectList *  pCurrent,
InstanceObjectList *&  pList,
const Matrix m,
const void *  instanceCRC = nullptr 
)
static

Update pCurrent data with the given information, added to the list if one is provided.

Parameters
[in]pObjObject used for the instance.
[in]pCurrentData structure to fill up.
[in,out]pListOptional List, pCurrent is added to the list if provided.
[in]mMatrix to use for this instance.
[in]instanceCRCUnique pointer used for CRC (used for multi-instance).

◆ RecurseGenList()

static void RecurseGenList ( BaseObject op,
BaseObject generator,
HierarchyHelp hh = nullptr 
)
static

Add op and its children as a dependency to the generator.

Parameters
[in]opBaseObject the generator depends on.
[in]generatorGenerator to add the dependencies to.
[in]hhOptional HierarchyHelp.

◆ AddCacheInstanceData()

maxon::Result<void> AddCacheInstanceData ( InstanceObjectList *&  pList)

Update the instance list with the cached instance data.

Parameters
[in,out]pListCurrent list to fill if provided. If null, a new list may be returned.

◆ GetReferenceObject()

BaseObject* GetReferenceObject ( BaseDocument doc) const

Return the pointer to the BaseObject being instanciated. Same as accessing the INSTANCEOBJECT_LINK element in the BaseContainer.

Parameters
[in]docThe current document.
Returns
Object being instanciated. Will be null if this instance object is unassigned.

◆ SetReferenceObject()

maxon::Result<void> SetReferenceObject ( BaseObject refObj)

Set the reference object used for the multiple instances (INSTANCEOBJECT_LINK in BaseContainer).

Parameters
[in]refObjdesired reference object.

◆ IsMultiInstance()

Bool IsMultiInstance ( ) const

Return whether this InstanceObject is in multi-instance mode.

Returns
True if in multi-instance mode.

◆ SetInstanceMatrices()

maxon::Result<void> SetInstanceMatrices ( const maxon::BaseArray< Matrix > &  matrices)

Set matrices for the instance(s). The array size determines the instance count.

Parameters
[in]matricesInstance matrix array.

◆ GetInstanceMatrices()

const maxon::BaseArray<Matrix>* GetInstanceMatrices ( ) const

Returns an array of matrices with one element for each instance.

Returns
Pointer to the matrix array. Owned by the InstanceObject.

◆ GetInstanceMatrix()

Matrix GetInstanceMatrix ( UInt  index) const

Return the global matrix of the instance at the specified index.

Parameters
[in]indexInstance index.
Returns
Instance matrix.

◆ SetInstanceMatrix()

maxon::Result<void> SetInstanceMatrix ( UInt  index,
const Matrix globalMatrix 
)

Set the global matrix of the instance at the specified index. index must be valid, there is no allocation for index out of range.

Parameters
[in]indexInstance index.
[in]globalMatrixInstance matrix.

◆ GetMatrixDirtyID()

UInt32 GetMatrixDirtyID ( UInt  index) const

Return the Matrix dirtyID of the instance at the specified index.

Parameters
[in]indexInstance index.
Returns
dirty ID.

◆ GetInstanceCount()

UInt GetInstanceCount ( ) const

Return the multi-instance count (number of instances and matrices).

Returns
Multi-instance count.

◆ SetInstanceColors()

maxon::Result<void> SetInstanceColors ( const maxon::BaseArray< maxon::Color64 > &  colors)

Set colors for the instances. Colors will be clamped between 0 and 1.

Parameters
[in]colorsArray of instance colors.

◆ GetInstanceColors()

const maxon::BaseArray<maxon::Color64>* GetInstanceColors ( ) const

Return an array of instance colors. If the array is null or empty, the default color is used.

Returns
Pointer to the color array. Owned by the InstanceObject.

◆ GetInstanceColor()

maxon::Color64 GetInstanceColor ( UInt  index) const

Return the color of the instance at the specified index. If no custom color is found or the index is invalid, the default color is returned.

Parameters
[in]indexInstance index.
Returns
Instance color.

◆ SetInstanceUniqueIPs()

maxon::Result<void> SetInstanceUniqueIPs ( const maxon::BaseArray< Int32 > &  uniqueIPs)

Set unique IP for the instances.

Parameters
[in]uniqueIPsArray of instance unique IP.

◆ GetInstanceUniqueIPs()

const maxon::BaseArray<Int32>* GetInstanceUniqueIPs ( ) const

Return an array of instance unique IP. If the array is null or empty, 0 is used.

Returns
Pointer to the unique IP array. Owned by the InstanceObject.

◆ GetInstanceUniqueIP()

Int32 GetInstanceUniqueIP ( UInt  index) const

Return the unique IP of the instance at the specified index. If no unique IP is found or the index is invalid, 0 is returned.

Parameters
[in]indexInstance index.
Returns
Instance unique IP.