Open Search
    Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
    NodeData Class Reference

    #include <c4d_nodedata.h>

    Inheritance diagram for NodeData:
    Inheritance graph
    [legend]

    Public Types

    typedef PrivateChunk SUPER
     

    Public Member Functions

    virtual Bool IsInstanceOf (cineware::Int32 id) const
     
    - Public Member Functions inherited from PrivateChunk
     PrivateChunk ()
     
    Bool ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
     
    virtual Bool IsListHead ()
     
    virtual Int32 GetType () const
     
    virtual Int32 GetInstanceType () const
     
    Bool ReadObject (HyperFile *hf, Bool readheader)
     
    Bool WriteObject (HyperFile *hf, Int32 type)
     
    virtual Bool Write (HyperFile *hf)
     
    Bool CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
     
    virtual Bool GetDParameter (const DescID &id, GeData &data)
     
    virtual Bool SetDParameter (const DescID &id, const GeData &data)
     
    Bool GetParameter (Int32 id, GeData &data)
     
    Bool SetParameter (Int32 id, const GeData &data)
     
    Bool GetParameter (const DescID &id, GeData &data)
     
    Bool SetParameter (const DescID &id, const GeData &data)
     
    virtual Int32 GetChunkLevel ()
     
    - Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
    PrivateChunk * GetNext () const
     
    PrivateChunk * GetPrev () const
     
    void InsertBefore (PrivateChunk *n)
     
    void InsertAfter (PrivateChunk *n)
     
    void Remove ()
     

    Protected Member Functions

    virtual Bool Init ()
     
    virtual void Free ()
     
    virtual Bool Read (HyperFile *hf, Int32 id, Int32 level)
     
    virtual Bool Execute ()
     
    virtual Int32 GetDiskType () const
     
    virtual Bool CopyToX (PrivateChunk *dst, COPYFLAGS flags, AliasTrans *trans)
     
    virtual Bool TranslateDescID (GeListNode *node, const DescID &id, DescID &res_id, GeListNode *&res_at)
     
    - Protected Member Functions inherited from PrivateChunk
    virtual Bool HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
     

    Private Member Functions

    Bool GetParameter (Int32 id, GeData &data)
     
    Bool SetParameter (Int32 id, const GeData &data)
     
    Bool GetParameter (const DescID &id, GeData &data)
     
    Bool SetParameter (const DescID &id, const GeData &data)
     

    Private Attributes

    BaseList2D * m_ptr
     

    Friends

    class BaseList2D
     
    class BaseObject
     
    class BaseTag
     
    class BaseShader
     
    class BaseVideoPost
     
    class BaseSceneHook
     
    class BaseSceneHookData
     
    class PluginNode
     
    class BaseOverrideData
     
    class BaseMaterial
     

    Constructor

     NodeData ()
     

    Node

    BaseList2D * GetNode ()
     
    void SetNode (BaseList2D *ptr)
     

    Tag

    BaseTag * GetTag (Int32 id)
     
    BaseTag * MakeTag (Int32 id)
     

    Detailed Description

    Parent class for all object data. All data types (e.g. Polygon, Light, Camera) are derived from this class.

    See also
    The articles Implementation (Cineware SDK) and Implementation on the External Side.

    Member Typedef Documentation

    ◆ SUPER

    typedef PrivateChunk SUPER

    Constructor & Destructor Documentation

    ◆ NodeData()

    NodeData ( )

    Default constructor.

    Member Function Documentation

    ◆ IsInstanceOf()

    virtual Bool IsInstanceOf ( cineware::Int32  id) const
    		virtual

    Reimplemented from PrivateChunk.

    Reimplemented in BaseOverrideData, BaseTakeData, MeshDeformerObjectData, GroupPlaceholder, TakeFolderData, VariationShaderData, WeightTagData, SkinObjectData, TakeSystemHook, MoGraphFractureVoronoiObject, JointObjectData, LightObjectData, PointObjectData, InstanceObjectData, OverrideGroupData, VolumeBuilderData, VolumeSetData, SkyShaderObjectData, CloudData, GvExpressionData, HNWeightTagData, LodObjectData, PolygonObjectData, PointGenerator, CameraObjectData, CloudGroupData, GIData, VPXMBData, BaseSceneHookData, and HairLightTagData.

    ◆ Init()

    virtual Bool Init ( )
    		protectedvirtual

    Called when an instance of a derived node data class needs to be initialized.

    Returns
    true if successful, otherwise false.

    Reimplemented in PoseMorphTagData, BaseOverrideData, BaseTakeData, MeshDeformerObjectData, GvRealNodeData, GroupPlaceholder, InstanceObjectData, TakeFolderData, SkinObjectData, VariationShaderData, LodObjectData, WeightTagData, HNWeightTagData, TakeSystemHook, MoGraphFractureVoronoiObject, BaseSceneHookData, GvRealNodeMasterData, JointObjectData, VolumeSetData, VolumeBuilderData, CloudData, GvOperatorData, GvExpressionData, OverrideGroupData, CameraObjectData, SkyShaderObjectData, GIData, PointGenerator, BaseSettings, CloudGroupData, VPXMBData, and HairLightTagData.

    ◆ Free()

    virtual void Free ( )
    		protectedvirtual

    Reimplemented in PoseMorphTagData, BaseOverrideData, BaseTakeData, MeshDeformerObjectData, InstanceObjectData, VariationShaderData, LodObjectData, WeightTagData, HNWeightTagData, TakeSystemHook, MoGraphFractureVoronoiObject, JointObjectData, VolumeSetData, VolumeBuilderData, GvExpressionData, and BaseSettings.

    ◆ Read()

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

    Reads the node from a hyper file.

    Parameters
    [in]hfThe hyper file to read from. Cineware SDK owns the pointed hyper file.
    [in]idThe ID of the node to read.
    [in]levelThe disklevel of the node to read.
    Returns
    true if successful, otherwise false.

    Reimplemented in PoseMorphTagData, BaseOverrideData, BaseTakeData, MeshDeformerObjectData, InstanceObjectData, GvRealNodeData, SkinObjectData, VariationShaderData, PolygonObjectData, LightObjectData, LodObjectData, SkyShaderObjectData, WeightTagData, CloudData, HNWeightTagData, CloudGroupData, TakeSystemHook, JointObjectData, PointObjectData, MoGraphFractureVoronoiObject, VolumeSetData, GvRealNodeMasterData, VolumeBuilderData, GvExpressionData, BaseSceneHookData, GvOperatorData, PointGenerator, GIData, BaseSettings, and HairLightTagData.

    ◆ Execute()

    virtual Bool Execute ( )
    		protectedvirtual

    Overload this for self defined Alien data classes. Called when Cineware SDK loads a document.

    Returns
    true if the node type is supported by the external application, otherwise false.

    ◆ GetDiskType()

    virtual Int32 GetDiskType ( ) const
    		protectedvirtual

    Gets the node's unique disk type ID.

    Returns
    The node's disk type.

    Reimplemented in JointObjectData, PointObjectData, and PolygonObjectData.

    ◆ CopyToX()

    virtual Bool CopyToX ( PrivateChunk *  dst,
    COPYFLAGS  flags,
    AliasTrans *  trans 
    )
    		protectedvirtual

    Private.

    Reimplemented from PrivateChunk.

    Reimplemented in BaseSceneHookData, LightObjectData, PolygonObjectData, CloudData, PointObjectData, SkyShaderObjectData, CloudGroupData, PoseMorphTagData, BaseOverrideData, BaseTakeData, MeshDeformerObjectData, InstanceObjectData, GvRealNodeData, SkinObjectData, LodObjectData, WeightTagData, HNWeightTagData, TakeSystemHook, JointObjectData, MoGraphFractureVoronoiObject, VolumeSetData, VolumeBuilderData, GvRealNodeMasterData, GvExpressionData, and PointGenerator.

    ◆ TranslateDescID()

    virtual Bool TranslateDescID ( GeListNode *  node,
    const DescID &  id,
    DescID &  res_id,
    GeListNode *&  res_at 
    )
    		protectedvirtual

    Private.

    Reimplemented in BaseOverrideData.

    ◆ GetParameter() [1/2]

    Bool GetParameter ( Int32  id,
    GeData &  data 
    )
    		private

    ◆ SetParameter() [1/2]

    Bool SetParameter ( Int32  id,
    const GeData &  data 
    )
    		private

    ◆ GetParameter() [2/2]

    Bool GetParameter ( const DescID &  id,
    GeData &  data 
    )
    		private

    ◆ SetParameter() [2/2]

    Bool SetParameter ( const DescID &  id,
    const GeData &  data 
    )
    		private

    ◆ GetNode()

    BaseList2D* GetNode ( )

    Gets the object connected with the data instance.

    Returns
    The object. The caller owns the pointed object.

    ◆ SetNode()

    void SetNode ( BaseList2D *  ptr)

    Sets the object connected with the data instance.

    Parameters
    [in]ptrThe object to set. The caller owns the pointed object.

    ◆ GetTag()

    BaseTag* GetTag ( Int32  id)
    See also
    BaseObject::GetTag(Int32 id)

    ◆ MakeTag()

    BaseTag* MakeTag ( Int32  id)
    See also
    BaseObject::MakeTag(Int32 id)

    Friends And Related Function Documentation

    ◆ BaseList2D

    friend class BaseList2D
    		friend

    ◆ BaseObject

    friend class BaseObject
    		friend

    ◆ BaseTag

    friend class BaseTag
    		friend

    ◆ BaseShader

    friend class BaseShader
    		friend

    ◆ BaseVideoPost

    friend class BaseVideoPost
    		friend

    ◆ BaseSceneHook

    friend class BaseSceneHook
    		friend

    ◆ BaseSceneHookData

    friend class BaseSceneHookData
    		friend

    ◆ PluginNode

    friend class PluginNode
    		friend

    ◆ BaseOverrideData

    friend class BaseOverrideData
    		friend

    ◆ BaseMaterial

    friend class BaseMaterial
    		friend

    Member Data Documentation

    ◆ m_ptr

    BaseList2D* m_ptr
    		private