Open Search
    BaseMaterial Class Reference

    #include <c4d_basematerial.h>

    Inheritance diagram for BaseMaterial:

    Detailed Description

    This is the material base class that all materials in Cinema 4D are derived from.

    Note
    Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

    Private Member Functions

     BaseMaterial ()
     
     ~BaseMaterial ()
     

    Allocation

    static BaseMaterialAlloc (Int32 type)
     
    static void Free (BaseMaterial *&bl)
     

    Navigation

    BaseMaterialGetNext ()
     
    BaseMaterialGetPred ()
     

    Update Material

    void Update (Bool preview, Bool rttm)
     

    Get Channel

    BaseChannelGetChannel (Int32 id)
     

    Textures

    INITRENDERRESULT InitTextures (const InitRenderStruct &irs)
     
    void UnlockTextures ()
     

    Calculation

    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)
     

    Miscellaneous

    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
     

    Additional Inherited Members

    - 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
     
    BaseList2DGetMain () 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
     
    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
     
    CTrackGetFirstCTrack ()
     
    const CTrackGetFirstCTrack () const
     
    CTrackFindCTrack (const DescID &id)
     
    const CTrackFindCTrack (const DescID &id) const
     
    - 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 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 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

    ◆ BaseMaterial()

    BaseMaterial ( )
    private

    ◆ ~BaseMaterial()

    ~BaseMaterial ( )
    private

    Member Function Documentation

    ◆ Alloc()

    static BaseMaterial* Alloc ( Int32  type)
    static

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

    Parameters
    [in]typeThe material type: Material Types
    Returns
    The allocated base material, or nullptr if the allocation failed.

    ◆ Free()

    static void Free ( BaseMaterial *&  bl)
    static

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

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

    ◆ GetNext()

    BaseMaterial* GetNext ( )

    Gets the next material in the list. Convenience version of GeListNode::GetNext() returning a BaseMaterial*.

    Returns
    The next material, or nullptr if there is none. Cinema 4D owns the pointed base material.

    ◆ GetPred()

    BaseMaterial* GetPred ( )

    Gets the previous material in the list. Convenience version of GeListNode::GetPred() returning a BaseMaterial*.

    Returns
    The previous material, or nullptr if there is none. Cinema 4D owns the pointed base material.

    ◆ Update()

    void Update ( Bool  preview,
    Bool  rttm 
    )

    Recalculates the material's thumbnail and updates its internal values.

    Note
    Recalculating the thumbnail/RTTM image is time intensive. It only needs to be done to let the user change the view. The calculations are done asynchronously.
    Parameters
    [in]previewIf true the preview thumbnail will be updated.
    [in]rttmIf true the real time texture map of the material will be recalculated.

    ◆ GetChannel()

    BaseChannel* GetChannel ( Int32  id)

    Retrieves the channel associated with a standard Material, such as the color channel or bump channel.

    Warning
    Only works with standard materials of type Mmaterial. For plugin materials this method does nothing and return nullptr.
    Parameters
    [in]idThe channel type: CHANNEL
    Returns
    The requested channel, or nullptr if there is no such channel or if the material is not a standard Material.

    ◆ InitTextures()

    INITRENDERRESULT InitTextures ( const InitRenderStruct irs)

    Initializes the material textures, loading any files required.

    Parameters
    [in]irsA struct with information about the upcoming material rendering. The caller owns the pointed struct.
    Returns
    The result of the initialization: INITRENDERRESULT

    ◆ UnlockTextures()

    void UnlockTextures ( )

    Unlocks all textures used by the material.

    ◆ Displace()

    void Displace ( VolumeData sd,
    const RayPolyWeight weights 
    )

    Calls the displacement routine of a material with associated barycentric weights.

    Note
    The passed VolumeData structure must be fully initialized and must contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.
    [in]weightsUse nullptr. Private.

    ◆ ChangeNormal()

    void ChangeNormal ( VolumeData sd)

    Calls the bump routine of a material. For plugin materials this is MaterialData::ChangeNormal().
    The call changes BaseVolumeData::bumpn.

    Note
    The passed VolumeData structure must be fully initialized and contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Warning
    Normalization is not done by the routine.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.

    ◆ CalcSurface()

    void CalcSurface ( VolumeData sd)

    Computes the surface properties of the material. For plugin materials this is MaterialData::CalcSurface().
    The call changes BaseVolumeData::col, BaseVolumeData::trans, BaseVolumeData::refl, BaseVolumeData::tray, BaseVolumeData::rray and/or BaseVolumeData::alpha (depending on the parameters).

    Note
    The passed VolumeData structure must be fully initialized and contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.

    ◆ CalcTransparency()

    void CalcTransparency ( VolumeData sd)

    Computes the transparency properties of the material. For plugin materials this is MaterialData::CalcTransparency().
    The call changes BaseVolumeData::trans.

    Note
    The passed VolumeData structure must be fully initialized and contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.

    ◆ CalcAlpha()

    void CalcAlpha ( VolumeData sd)

    Computes the alpha properties of the material. For plugin materials this is MaterialData::CalcAlpha().
    The call changes BaseVolumeData::alpha.

    Note
    The passed VolumeData structure must be fully initialized and contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.

    ◆ CalcVolumetric()

    void CalcVolumetric ( VolumeData sd)

    Computes the color of a volumetric ray in the material. For plugin materials this is MaterialData::CalcVolumetric().
    The call changes VolumeData::col and/or VolumeData::trans.

    Note
    The passed VolumeData structure must be fully initialized and contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.

    ◆ InitCalculation()

    void InitCalculation ( VolumeData sd,
    INITCALCULATION  type 
    )

    If (and only if) (GetRenderInfo() & VOLUMEINFO::INITCALCULATION) is true, then call this function, with the right type, before any of the calculation functions is called.

    Note
    The passed VolumeData structure must be fully initialized and contain a render instance. This can only be achieved by copying/initializing from an existing VolumeData.
    Parameters
    [in]sdA volume data to use and modify. The caller owns the pointed VolumeData.
    [in]typeSet the calculation type according to the method to call. See the default call order of MaterialData::InitCalculation().

    ◆ Compare()

    Bool Compare ( BaseMaterial snd)

    Check if the materials are identical.

    Note
    Only the name of the compared materials can be different.
    Parameters
    [in]sndThe material to compare with.
    Returns
    true if the materials contents are the same, otherwise false.

    ◆ GetPreview()

    BaseBitmap* GetPreview ( Int32  flags)

    Retrieves the preview picture of the material.

    Parameters
    [in]flags0 for the material editor preview, 1 for the viewport preview.
    Returns
    The preview picture. Guaranteed to be valid, i.e. not nullptr.
    Note
    To check if the preview has been calculated successfully, calling GetBw() on the returned bitmap should give a value superior than 0.

    ◆ GetRayIllumination()

    RayIllumination* GetRayIllumination ( )

    Private.

    ◆ GetAverageColor()

    Vector GetAverageColor ( Int32  channel = -1)

    Gets an average color for the material, based on the material preview.

    Parameters
    [in]channelAn optional specific channel to get the average for: CHANNEL
    Returns
    The average color.

    ◆ GetRenderInfo()

    VOLUMEINFO GetRenderInfo ( )

    Retrieves information about what the material requires from the raytracer and what it will return.

    Returns
    The return values are: VOLUMEINFO

    ◆ HasEditorTransparency()

    Bool HasEditorTransparency ( )

    Checks if the material supports viewport transparency.

    Returns
    true if the material support viewport transparency, otherwise false.

    ◆ InitEditorPreviewImage() [1/2]

    Bool InitEditorPreviewImage ( Int32  exponent,
    BaseDocument doc,
    BaseThread th,
    Int32  doccolorspace,
    Bool  linearworkflow 
    )

    Initializes the preview image for the editor. Private.

    ◆ InitEditorPreviewImage() [2/2]

    Bool InitEditorPreviewImage ( BaseBitmap bmp,
    BaseDocument doc,
    BaseThread th,
    Int32  doccolorspace,
    Bool  linearworkflow 
    ) const

    Initializes the preview image for the editor into a given BaseBitmap Private.