Open Search
    Material Class Reference

    #include <c4d_basematerial.h>

    Inheritance diagram for Material:

    Detailed Description

    The material with the Mmaterial type.

    Note
    Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.
    See also
    Mmaterial.h for container IDs.

    Private Member Functions

     Material ()
     
     ~Material ()
     

    Allocation

    static MaterialAlloc ()
     
    static void Free (Material *&bl)
     

    Reflection/Specular Layer Access

    static Bool RenderViewportImage (Material *material, BaseDocument *baseDocument, Int32 sizeExponent, Int32 xMin, Int32 yMin, Int32 xMax, Int32 yMax, BaseThread *parentThread, BaseBitmap &bitmap)
     
    static void ComputeFresnelMetal (Int32 fresnelMetal, Vector &fresnelIOR, Vector &fresnelK)
     
    static Float ComputeFresnelDielectric (Int32 fresnelPreset)
     
    ReflectionLayerAddReflectionLayer ()
     
    ReflectionLayerGetReflectionLayerID (Int32 id)
     
    ReflectionLayerGetReflectionLayerIndex (Int32 index)
     
    ReflectionLayerGetReflectionLayerTrans ()
     
    Int32 GetReflectionLayerCount ()
     
    Int32 GetReflectionLayerCount (Bool includeTransparencyLayers)
     
    void RemoveReflectionLayerID (Int32 id)
     
    void RemoveReflectionLayerIndex (Int32 index)
     
    void RemoveReflectionAllLayers ()
     
    void GetAllReflectionShaders (maxon::BaseArray< BaseShader * > &shaders)
     
    void GetReflectionPrimaryLayers (Int32 &reflection_layer, Int32 &specular_layer)
     

    Get/Set Channel State

    Bool GetChannelState (Int32 channel)
     
    void SetChannelState (Int32 channel, Bool state)
     

    Additional Inherited Members

    - 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 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)
     
    - Static Public Attributes inherited from BaseList2D
    static const Int32 SETBIT_FLAG_NODIRTY
     
    static const Int32 SETBIT_FLAG_REMOVE
     

    Constructor & Destructor Documentation

    ◆ Material()

    Material ( )
    private

    ◆ ~Material()

    ~Material ( )
    private

    Member Function Documentation

    ◆ Alloc()

    static Material* Alloc ( )
    static

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

    Returns
    The allocated material, or nullptr if the allocation failed.

    ◆ Free()

    static void Free ( Material *&  bl)
    static

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

    Parameters
    [in]blThe material to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

    ◆ GetChannelState()

    Bool GetChannelState ( Int32  channel)

    Gets the state of a channel (if it is enabled or disabled).

    Parameters
    [in]channelThe channel type: CHANNEL
    Returns
    true if the channel is enabled for this material, otherwise false.

    ◆ SetChannelState()

    void SetChannelState ( Int32  channel,
    Bool  state 
    )

    Sets the state of a channel (if it is enabled or disabled).

    Parameters
    [in]channelThe type of the channel to enable or disable: CHANNEL
    [in]statetrue to enable the given channel, otherwise false.

    ◆ AddReflectionLayer()

    ReflectionLayer* AddReflectionLayer ( )

    Adds a reflection/specular layer.

    Since
    R16
    Returns
    The added reflection/specular layer. Cinema 4D owns the pointed layer.

    ◆ GetReflectionLayerID()

    ReflectionLayer* GetReflectionLayerID ( Int32  id)

    Retrieves a reflection/specular layer by ID.

    Since
    R16
    Parameters
    [in]idThe layer ID.
    Returns
    The reflection/specular layer. Cinema 4D owns the pointed layer.

    ◆ GetReflectionLayerIndex()

    ReflectionLayer* GetReflectionLayerIndex ( Int32  index)

    Retrieves a reflection/specular layer by index.

    Since
    R16
    Parameters
    [in]indexThe layer index.
    Returns
    The reflection/specular layer. Cinema 4D owns the pointed layer.

    ◆ GetReflectionLayerTrans()

    ReflectionLayer* GetReflectionLayerTrans ( )

    Retrieves the transparency layer.

    Since
    R16
    Returns
    The transparency layer, or nullptr if not available. Cinema 4D owns the pointed layer.

    ◆ GetReflectionLayerCount() [1/2]

    Int32 GetReflectionLayerCount ( )

    Retrieves the number of reflection/specular layers.

    Since
    R16
    Returns
    The reflection/specular layers' count.

    ◆ GetReflectionLayerCount() [2/2]

    Int32 GetReflectionLayerCount ( Bool  includeTransparencyLayers)

    Retrieves the number of reflection/specular layers. Transparency layers can be optionally included in the count.

    Since
    S22
    Parameters
    [in]includeTransparencyLayersSpecifies if transparency layers should be included in the count.
    Returns
    The reflection/specular layers' count.

    ◆ RemoveReflectionLayerID()

    void RemoveReflectionLayerID ( Int32  id)

    Removes a reflection/specular layer by ID.

    Since
    R16
    Parameters
    [in]idThe layer ID.

    ◆ RemoveReflectionLayerIndex()

    void RemoveReflectionLayerIndex ( Int32  index)

    Removes a reflection/specular layer by index.

    Since
    R16
    Parameters
    [in]indexThe layer index.

    ◆ RemoveReflectionAllLayers()

    void RemoveReflectionAllLayers ( )

    Deletes all reflection/specular layers.

    Since
    R16

    ◆ GetAllReflectionShaders()

    void GetAllReflectionShaders ( maxon::BaseArray< BaseShader * > &  shaders)

    Retrieves all the reflection/specular shaders.

    Since
    R16
    Parameters
    [out]shadersAssigned all the reflection/specular shaders. Cinema 4D owns the pointed shaders.

    ◆ GetReflectionPrimaryLayers()

    void GetReflectionPrimaryLayers ( Int32 reflection_layer,
    Int32 specular_layer 
    )

    Retrieves the indices to the primary reflection and specular layers (can be -1 for empty).

    Since
    R16
    Parameters
    [out]reflection_layerThe most significant reflection layer.
    [out]specular_layerThe most significant specular layer.

    ◆ RenderViewportImage()

    static Bool RenderViewportImage ( Material material,
    BaseDocument baseDocument,
    Int32  sizeExponent,
    Int32  xMin,
    Int32  yMin,
    Int32  xMax,
    Int32  yMax,
    BaseThread parentThread,
    BaseBitmap bitmap 
    )
    static

    Private.

    ◆ ComputeFresnelMetal()

    static void ComputeFresnelMetal ( Int32  fresnelMetal,
    Vector fresnelIOR,
    Vector fresnelK 
    )
    static

    Private.

    ◆ ComputeFresnelDielectric()

    static Float ComputeFresnelDielectric ( Int32  fresnelPreset)
    static

    Private.