Open Search
    NodeMaterial Class Reference

    #include <c4d_basematerial.h>

    Inheritance diagram for NodeMaterial:

    Detailed Description

    The node-based material with the Mbase type. This class is a collection of accessors to node-related functionality that are grouped for clarity purposes. Note that any BaseMaterial can be elevated to a NodeMaterial, no special construction is needed.

    Public Member Functions

    Bool HasSpace (const maxon::Id &spaceId) const
     
    maxon::Result< void > GetMaterialNodePath (const maxon::Id &spaceId, maxon::NodePath &result) const
     
    maxon::Result< void > GetSoloNodePath (const maxon::Id &spaceId, maxon::NodePath &result) const
     
    maxon::Result< const BaseList2D * > GetBaseListForNode (const maxon::Id &spaceId, const maxon::NodePath &nodePath)
     
    maxon::Result< void > GetDescIDForNodePort (const maxon::Id &spaceId, const maxon::GraphNode &node, const maxon::GraphNode &port, DescID &result) const
     
    maxon::Result< const maxon::nodes::NodesGraphModelRef & > GetGraph (const maxon::Id &spaceId) const
     
    maxon::Result< void > AddGraph (const maxon::Id &spaceId)
     
    maxon::Result< void > CreateDefaultGraph (const maxon::Id &spaceId)
     
    maxon::Result< void > CreateEmptyGraph (const maxon::Id &spaceId)
     
    maxon::Result< void > RemoveGraph (const maxon::Id &spaceId)
     
    maxon::Result< BaseList2D * > UuidToBaseList2D (const maxon::Id &spaceId, const maxon::Uuid &uuid) const
     
    maxon::Result< BaseList2D * > UuidToBaseList2DResolveLink (const maxon::Id &spaceId, const maxon::Uuid &uuid, const maxon::NodeMaterialLinkResolveFunc &linkResolveFunc)
     
    maxon::Result< maxon::UuidBaseList2DToUuid (const maxon::Id &spaceId, BaseList2D *object) const
     
    - Public Member Functions inherited from BaseMaterial
    BaseMaterialGetNext ()
     
    BaseMaterialGetPred ()
     
    void Update (Bool preview, Bool rttm)
     
    BaseChannelGetChannel (Int32 id)
     
    INITRENDERRESULT InitTextures (const InitRenderStruct &irs)
     
    void UnlockTextures ()
     
    void Displace (VolumeData *sd, const RayPolyWeight *weights)
     
    void ChangeNormal (VolumeData *sd)
     
    void CalcSurface (VolumeData *sd)
     
    void CalcTransparency (VolumeData *sd)
     
    void CalcAlpha (VolumeData *sd)
     
    void CalcVolumetric (VolumeData *sd)
     
    void InitCalculation (VolumeData *sd, INITCALCULATION type)
     
    Bool Compare (BaseMaterial *snd)
     
    BaseBitmapGetPreview (Int32 flags)
     
    RayIlluminationGetRayIllumination ()
     
    Vector GetAverageColor (Int32 channel=-1)
     
    VOLUMEINFO GetRenderInfo ()
     
    Bool HasEditorTransparency ()
     
    Bool InitEditorPreviewImage (Int32 exponent, BaseDocument *doc, BaseThread *th, Int32 doccolorspace, Bool linearworkflow)
     
    Bool InitEditorPreviewImage (BaseBitmap *bmp, BaseDocument *doc, BaseThread *th, Int32 doccolorspace, Bool linearworkflow) 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 CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
     
    BaseList2DGetNext ()
     
    const BaseList2DGetNext () const
     
    BaseList2DGetPred ()
     
    const BaseList2DGetPred () const
     
    BaseContainer GetData ()
     
    void SetData (const BaseContainer &bc, Bool add=true)
     
    const BaseContainerGetDataInstanceRef () const
     
    BaseContainerGetDataInstanceRef ()
     
    const BaseContainerGetDataInstance () const
     
    BaseContainerGetDataInstance ()
     
    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)
     
    GeListHeadGetNLARoot (Bool create)
     
    BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
     
    String GetTypeName () const
     
    const BaseList2DGetMain () const
     
    BaseList2DGetMain ()
     
    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
     
    GeListHeadGetOverrideRoot (Bool create)
     
    BaseOverrideGetFirstOverride ()
     
    GeListHeadGetShaderRepositoryRoot (Bool create)
     
    GeListHeadGetHiddenShaderRoot (Bool create)
     
    maxon::NimbusForwardRef GetNimbusRef (const maxon::Id &spaceId) const
     
    maxon::Result< maxon::NimbusForwardRefPrivateGetOrCreateNimbusRef (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< BoolGetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< maxon::GenericDataGroupChanges ()
     
    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 (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
     
    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 (const BaseDocument *doc)
     
    const LayerObjectGetLayerObject (const BaseDocument *doc) const
     
    Bool SetLayerObject (const LayerObject *layer)
     
    const LayerDataGetLayerData (const BaseDocument *doc, Bool rawdata=false) const
     
    Bool SetLayerData (BaseDocument *doc, const LayerData &data)
     
    GeListHeadGetCTrackRoot (Bool create)
     
    const GeListHeadGetCTrackRoot () const
     
    const CTrackGetFirstCTrack () const
     
    CTrackGetFirstCTrack ()
     
    const CTrackFindCTrack (const DescID &id) const
     
    CTrackFindCTrack (const DescID &id)
     
    - Public Member Functions inherited from GeListNode
    GeListNodeGetNext ()
     
    const GeListNodeGetNext () const
     
    GeListNodeGetPred ()
     
    const GeListNodeGetPred () const
     
    GeListNodeGetDown ()
     
    const GeListNodeGetDown () const
     
    GeListNodeGetUp ()
     
    const GeListNodeGetUp () const
     
    GeListNodeGetDownLast ()
     
    const GeListNodeGetDownLast () 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)
     
    GeListHeadGetListHead ()
     
    const GeListHeadGetListHead () 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)
     
    GeListNodeGetCustomData ()
     
    const GeListNodeGetCustomData () const
     
    const BaseDocumentGetDocument () const
     
    BaseDocumentGetDocument ()
     
    maxon::Result< BoolGetBranchInfo (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)
     
    C4DAtomGetClone (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)
     
    DynamicDescriptionGetDynamicDescriptionWritable ()
     
    const DynamicDescriptionGetDynamicDescription () 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

    static maxon::Result< void > GetTextureSearchPaths (const maxon::Url &secondaryPath, const maxon::Url &documentPath, maxon::BaseArray< maxon::Url > &result)
     
    static BaseMaterialGetMaterial (const maxon::nodes::NodesGraphModelRef &graph)
     
    - Static Public Member Functions inherited from BaseMaterial
    static BaseMaterialAlloc (Int32 type)
     
    static void Free (BaseMaterial *&bl)
     
    - Static Public Member Functions inherited from BaseList2D
    static BaseList2DAlloc (Int32 type)
     
    static void Free (BaseList2D *&bl)
     

    Private Member Functions

     NodeMaterial ()
     
     ~NodeMaterial ()
     

    Additional Inherited Members

    - Static Public Attributes inherited from BaseList2D
    static const Int32 SETBIT_FLAG_NODIRTY
     
    static const Int32 SETBIT_FLAG_REMOVE
     

    Constructor & Destructor Documentation

    ◆ NodeMaterial()

    NodeMaterial ( )
    private

    ◆ ~NodeMaterial()

    ~NodeMaterial ( )
    private

    Member Function Documentation

    ◆ HasSpace()

    Bool HasSpace ( const maxon::Id spaceId) const

    Checks whether the node space under the provided id was instantiated for the material.

    Parameters
    [in]spaceIdThe id of the node space.
    Returns
    Returns true if the node space exists, false otherwise.

    ◆ GetMaterialNodePath()

    maxon::Result<void> GetMaterialNodePath ( const maxon::Id spaceId,
    maxon::NodePath &  result 
    ) const

    Returns the node path to the material end node.

    Parameters
    [in]spaceIdThe id of the node space.
    [out]resultThe path to the material end node.
    Returns
    OK on success, or IllegalStateError if the material does not have this space.

    ◆ GetSoloNodePath()

    maxon::Result<void> GetSoloNodePath ( const maxon::Id spaceId,
    maxon::NodePath &  result 
    ) const

    Returns the node path to the solo node.

    Parameters
    [in]spaceIdThe id of the node space.
    [out]resultThe path to the solo node, empty if nothing was soloed.
    Returns
    OK on success, or IllegalStateError if the material does not have this space.

    ◆ GetBaseListForNode()

    maxon::Result<const BaseList2D*> GetBaseListForNode ( const maxon::Id spaceId,
    const maxon::NodePath &  nodePath 
    )

    Returns the corresponding BaseList element for a GraphNode.

    Parameters
    [in]spaceIdThe id of the node space.
    [in]nodePathAbsolute Path to the Node.
    Returns
    BaseList2D element. The return value can be nullptr if there's no corresponding element, or if it refers to an inner node.

    ◆ GetDescIDForNodePort()

    maxon::Result<void> GetDescIDForNodePort ( const maxon::Id spaceId,
    const maxon::GraphNode node,
    const maxon::GraphNode port,
    DescID result 
    ) const

    Calculates the DescID for a given port.

    Parameters
    [in]spaceIdThe id of the node space.
    [in]nodeThe node that owns the port.
    [in]portThe port.
    [out]resultThe description ID of the port.
    Returns
    OK on success. If no description representation exists an error will be returned.

    ◆ GetTextureSearchPaths()

    static maxon::Result<void> GetTextureSearchPaths ( const maxon::Url secondaryPath,
    const maxon::Url documentPath,
    maxon::BaseArray< maxon::Url > &  result 
    )
    static

    Determines the paths pointing to directories that are used to reference images by relative path in a particular BaseDocument.

    Parameters
    [in]secondaryPath(Optional) allows to provide the DOCUMENT_SECONDARYPATH.
    [in]documentPathThe path of the BaseDocument.
    [out]resultThe set of paths in which the images may be located.
    Returns
    OK on success, or OutOfMemoryError if the allocation failed.

    Generally, the usage is as follows:

    maxon::BaseArray<maxon::Url> textureSearchPaths;
    maxon::Url docpath = doc ? maxon::MaxonConvert(doc->GetDocumentPath(), maxon::MAXONCONVERTMODE::NONE) : maxon::Url();
    NONE
    Definition: asset_browser.h:1
    BaseDocument * GetActiveDocument()
    maxon::Url MaxonConvert(const Filename &fn, MAXONCONVERTMODE convertMode)
    Definition: c4d_basedocument.h:497
    static maxon::Result< void > GetTextureSearchPaths(const maxon::Url &secondaryPath, const maxon::Url &documentPath, maxon::BaseArray< maxon::Url > &result)
    Definition: c4d_basematerial.h:459
    Definition: basearray.h:415
    Definition: url.h:942
    The maxon namespace contains all declarations of the MAXON API.
    Definition: autoweight.h:14
    const char * doc
    Definition: pyerrors.h:226
    #define iferr_return
    Definition: resultbase.h:1524

    If needed, secondaryPath may be determined as follows:

    maxon::Url secondaryPath = maxon::MaxonConvert(doc->GetDataInstanceRef().GetFilename(DOCUMENT_SECONDARYPATH), maxon::MAXONCONVERTMODE::NONE);
    @ DOCUMENT_SECONDARYPATH
    Definition: ddoc.h:122

    ◆ GetMaterial()

    static BaseMaterial* GetMaterial ( const maxon::nodes::NodesGraphModelRef &  graph)
    static

    Returns the material owner of the provided graph. Please note that the returned BaseMaterial is only safe for access in the usual places of the API. You must avoid to perform read or write access to it in an arbitrary worker thread.

    Parameters
    [in]graphThe node graph of the owner.
    Returns
    Returns the owner of the node graph, null if unknown or on failure to retrieve.

    ◆ GetGraph()

    maxon::Result<const maxon::nodes::NodesGraphModelRef&> GetGraph ( const maxon::Id spaceId) const

    Returns the node graph for the provided node space id.

    Parameters
    [in]spaceIdThe id of the node space.
    Returns
    Returns the node graph, or IllegalStateError if the material does not have this space.

    ◆ AddGraph()

    maxon::Result<void> AddGraph ( const maxon::Id spaceId)

    Creates a node graph for the provided node space identifier if a graph does not already exist.

    Parameters
    [in]spaceIdThe id of the node space.
    Returns
    OK on success, or error on failure of graph creation.

    ◆ CreateDefaultGraph()

    maxon::Result<void> CreateDefaultGraph ( const maxon::Id spaceId)

    Creates a node graph populated with default nodes for the provided node space identifier if a graph does not already exist.

    Parameters
    [in]spaceIdThe id of the node space.
    Returns
    OK on success, or error on failure of graph creation.

    ◆ CreateEmptyGraph()

    maxon::Result<void> CreateEmptyGraph ( const maxon::Id spaceId)

    Creates an empty node graph for the provided node space identifier if a graph does not already exist.

    Parameters
    [in]spaceIdThe id of the node space.
    Returns
    OK on success, or error on failure of graph creation.

    ◆ RemoveGraph()

    maxon::Result<void> RemoveGraph ( const maxon::Id spaceId)

    Removes a node graph for the provided node space id if there is a graph.

    Parameters
    [in]spaceIdThe id of the node space.
    Returns
    OK on success, or error if removal fails.

    ◆ UuidToBaseList2D()

    maxon::Result<BaseList2D*> UuidToBaseList2D ( const maxon::Id spaceId,
    const maxon::Uuid uuid 
    ) const

    Returns the BaseList2D element with the given uuid.

    Parameters
    [in]spaceIdThe id of the node space.
    [in]uuidUuid to find.
    Returns
    BaseList2D object on success.

    ◆ UuidToBaseList2DResolveLink()

    maxon::Result<BaseList2D*> UuidToBaseList2DResolveLink ( const maxon::Id spaceId,
    const maxon::Uuid uuid,
    const maxon::NodeMaterialLinkResolveFunc linkResolveFunc 
    )

    Returns the BaseList2D element with the given uuid using an externally provided link resolve mechanism.

    Parameters
    [in]spaceIdThe id of the node space.
    [in]uuidUuid to find.
    [in]linkResolveFuncFunction to resolve the BaseLink.
    Returns
    BaseList2D object on success.

    ◆ BaseList2DToUuid()

    maxon::Result<maxon::Uuid> BaseList2DToUuid ( const maxon::Id spaceId,
    BaseList2D object 
    ) const

    Returns the uuid of the given BaseList2D object.

    Parameters
    [in]spaceIdThe id of the node space.
    [in]objectBaseList2D object to find.
    Returns
    Uuid on success.