Open Search
    Private Member Functions | List of all members
    InstanceObject Class Reference
    Library » Object Instance

    #include <lib_instanceobject.h>

    Inheritance diagram for InstanceObject:
    Inheritance graph
    [legend]

    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 InstanceObject * Alloc ()
     
    static void Free (InstanceObject *&bl)
     

    Viewport helper. Internal Use only.

    Private.

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

    Multi-instance reference object.

    const BaseObject * GetReferenceObject (const 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)
     
    maxon::Result< void > SetInstanceMatrices (maxon::BaseArray< Matrix > &&matrices)
     
    const maxon::BaseArray< Matrix > * GetInstanceMatrices () const
     
    Matrix GetInstanceMatrix (UInt index) const
     
    maxon::Result< void > SetInstanceMatrix (UInt index, const Matrix &globalMatrix)
     
    maxon::Result< void > SetInstanceDeformationMatrices (const maxon::BaseArray< Matrix > &matrices)
     
    maxon::Result< void > SetInstanceDeformationMatrices (maxon::BaseArray< Matrix > &&matrices)
     
    const maxon::BaseArray< Matrix > * GetInstanceDeformationMatrices () const
     
    const maxon::BaseArray< Matrix > * GetInstanceUndeformedMatrices () const
     
    const maxon::BaseArray< Matrix > * GetInstanceUndeformedLocalMatrices () const
     
    Bool HasDeformationMatrices ()
     
    void ClearInstanceDeformedMatrices ()
     
    UInt32 GetMatrixDirtyID (UInt index) const
     
    UInt GetInstanceCount () const
     

    Multi-instance color accessors.

    maxon::Result< void > SetInstanceColors (const maxon::BaseArray< maxon::Color64 > &colors)
     
    maxon::Result< void > SetInstanceColors (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)
     
    maxon::Result< void > SetInstanceUniqueIPs (maxon::BaseArray< Int32 > &&uniqueIPs)
     
    const maxon::BaseArray< Int32 > * GetInstanceUniqueIPs () const
     
    Int32 GetInstanceUniqueIP (UInt index) const
     
    maxon::Block< const maxon::UniqueHash > GetInstancePersistentHashes () const
     
    maxon::Result< void > SetLocalInstanceMatrices (const maxon::BaseArray< Matrix > &matrices)
     
    maxon::Result< void > SetLocalInstanceMatrices (maxon::BaseArray< Matrix > &&matrices)
     

    Additional Inherited Members

    - Public Member Functions inherited from BaseObject
    const Matrix & GetDeformMatrix () const
     
    void SetDeformMatrix (const Matrix &dm)
     
    void ClearDeformMatrix ()
     
    const Matrix & GetUndeformedMl () const
     
    const Matrix & GetUndeformedMlInverse () const
     
    Matrix GetUndeformedMg () const
     
    Bool HasDeformMatrix () const
     
    BaseObject * GetNext ()
     
    const BaseObject * GetNext () const
     
    BaseObject * GetPred ()
     
    const BaseObject * GetPred () const
     
    BaseObject * GetUp ()
     
    const BaseObject * GetUp () const
     
    BaseObject * GetDown ()
     
    const BaseObject * GetDown () const
     
    BaseObject * GetDownLast ()
     
    const BaseObject * GetDownLast () const
     
    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 Matrix & GetMl () 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) const
     
    Vector GetMp () const
     
    Vector GetRad () const
     
    void GetDimension (Vector &mp, Vector &rad) const
     
    Int32 GetEditorMode () const
     
    Int32 GetEditorModeH () const
     
    void SetEditorMode (Int32 mode)
     
    Int32 GetRenderMode () const
     
    Int32 GetRenderModeH () const
     
    void SetRenderMode (Int32 mode)
     
    Bool GetDeformMode () const
     
    void SetDeformMode (Bool mode)
     
    Int32 GetRealDeformMode () const
     
    void SetRealDeformMode (Int32 mode)
     
    Int32 GetUniqueIP () const
     
    void SetUniqueIP (Int32 ip)
     
    BaseTag * GetFirstTag ()
     
    const BaseTag * GetFirstTag () const
     
    BaseTag * GetLastTag ()
     
    const BaseTag * GetLastTag () const
     
    BaseTag * GetTag (Int32 type, Int32 nr=0)
     
    const BaseTag * GetTag (Int32 type, Int32 nr=0) const
     
    maxon::Block< const BaseTag *const > GetTagsOfType (Int32 type) const
     
    maxon::Block< BaseTag *const > GetTagsOfType (Int32 type)
     
    const void * GetTagDataR (Int32 type, Int32 nr=0) const
     
    void * GetTagDataW (Int32 type, Int32 nr=0)
     
    Int32 GetTagDataCount (Int32 type) const
     
    const VariableTagDataRef & GetVariableTagData (Int32 type, Int32 nr=0) const
     
    BaseTag * MakeTag (Int32 type, BaseTag *pred=nullptr)
     
    VariableTag * MakeVariableTag (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) const
     
    BaseObject * GetCache ()
     
    const BaseObject * GetCache () const
     
    BaseObject * GetDeformCache ()
     
    const BaseObject * GetDeformCache () const
     
    LineObject * GetIsoparm ()
     
    void SetIsoparm (LineObject *l)
     
    BaseObject * GetCacheParent () const
     
    BaseObject * GetCacheTopParent () const
     
    Bool SetPhong (Bool on, Bool anglelimit, Float angle)
     
    Bool IsDirty (DIRTYFLAGS flags) const
     
    void SetDirty (DIRTYFLAGS flags)
     
    Bool CheckCache (const HierarchyHelp *hh) const
     
    void Touch ()
     
    void GetColorProperties (ObjectColorProperties *prop) const
     
    void SetColorProperties (ObjectColorProperties *prop)
     
    maxon::Opt< maxon::Color > GetDisplayColor () const
     
    const Matrix & GetModelingAxis (BaseDocument *doc)
     
    void SetModelingAxis (const Matrix &m)
     
    BaseObject * GetAndCheckHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, Int childCount, maxon::BaseArray< BaseObject * > *children, Bool addChildOrClone=false)
     
    BaseObject * GetAndCheckHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, Bool allchildren)
     
    BaseObject * GetHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans)
     
    BaseObject * GetHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, DIRTYFLAGS dirtyflags)
     
    void NewDependenceList ()
     
    Bool CompareDependenceList ()
     
    void AddDependence (const BaseObject *op)
     
    void AddDependence (const BaseObject *op, DIRTYFLAGS dirtyflags)
     
    void TouchDependenceList ()
     
    void SetRotationOrder (ROTATIONORDER order)
     
    ROTATIONORDER GetRotationOrder () const
     
    void SetQuaternionRotationMode (Bool active, Bool bUndo)
     
    Bool IsQuaternionRotationMode ()
     
    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)
     
    SplineObject * GetRealSpline ()
     
    const SplineObject * GetRealSpline () const
     
    Float GetVisibility (Float parent) const
     
    Bool SearchHierarchy (const BaseObject *op) const
     
    BaseObject * GetOrigin (Bool safe)
     
    const BaseObject * GetOrigin (Bool safe) const
     
    void SetOrigin (BaseObject *origin)
     
    BaseObject * GetTopOrigin (Bool parent, Bool safe) const
     
    BaseObject * GetEditObject (BaseObject **psds, DISPLAYEDITSTATE state, Bool safetey=true) const
     
    void RemoveFromCache (Bool clearParentObject=true)
     
    DRAWRESULT ObjDraw (DRAWPASS drawpass, BaseDraw *bd, BaseDrawHelp *bh)
     
    maxon::Tuple< Bool, maxon::HashInt > GetObjectDrawHash (Int32 type) const
     
    void GetDrawStateData (void *state) const
     
    - 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
     
    BaseList2D * GetMain () const
     
    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
     
    CTrack * GetFirstCTrack ()
     
    const CTrack * GetFirstCTrack () const
     
    CTrack * FindCTrack (const DescID &id)
     
    const CTrack * FindCTrack (const DescID &id) const
     
    - 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 BaseObject
    static BaseObject * Alloc (Int32 type)
     
    static void Free (BaseObject *&bl)
     
    - 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

    ◆ 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.

    ◆ RecurseGenList()

    static void RecurseGenList ( const BaseObject *  op,
    BaseObject *  generator,
    const 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.

    ◆ GetReferenceObject()

    const BaseObject* GetReferenceObject ( const 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() [1/2]

    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.

    ◆ SetInstanceMatrices() [2/2]

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

    ◆ 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.

    ◆ SetInstanceDeformationMatrices() [1/2]

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

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

    Parameters
    [in]matricesInstance deformation matrix array.

    ◆ SetInstanceDeformationMatrices() [2/2]

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

    ◆ GetInstanceDeformationMatrices()

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

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

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

    ◆ GetInstanceUndeformedMatrices()

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

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

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

    ◆ GetInstanceUndeformedLocalMatrices()

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

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

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

    ◆ HasDeformationMatrices()

    Bool HasDeformationMatrices ( )

    Returns true if the instances have a deformation matrix.

    Returns
    True if instances have a deformation matrix

    ◆ ClearInstanceDeformedMatrices()

    void ClearInstanceDeformedMatrices ( )

    Clears instance deformed matrices.

    ◆ 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() [1/2]

    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.

    ◆ SetInstanceColors() [2/2]

    maxon::Result<void> SetInstanceColors ( maxon::BaseArray< maxon::Color64 > &&  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() [1/2]

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

    Set unique IP for the instances.

    Parameters
    [in]uniqueIPsArray of instance unique IP.

    ◆ SetInstanceUniqueIPs() [2/2]

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

    ◆ 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.

    ◆ GetInstancePersistentHashes()

    maxon::Block<const maxon::UniqueHash> GetInstancePersistentHashes ( ) const

    Return a block of persistent hashes. These allow to uniquely identify instances over time. If the block is empty, persistent hashes aren't supported, in that case you have to use GetInstanceUniqueIPs().

    Returns
    Block of instances hashes.

    ◆ SetLocalInstanceMatrices() [1/2]

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

    Set matrices for the instance(s). The array size determines the instance count. This function sets the matrices in local position relative to the Instance objects position.

    Parameters
    [in]matricesInstance matrix array.

    ◆ SetLocalInstanceMatrices() [2/2]

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