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)
 

Get/Set Channel State

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

Reflection/Specular Layer Access

ReflectionLayerAddReflectionLayer ()
 
ReflectionLayerGetReflectionLayerID (Int32 id)
 
ReflectionLayerGetReflectionLayerIndex (Int32 index)
 
ReflectionLayerGetReflectionLayerTrans ()
 
Int32 GetReflectionLayerCount ()
 
void RemoveReflectionLayerID (Int32 id)
 
void RemoveReflectionLayerIndex (Int32 index)
 
void RemoveReflectionAllLayers ()
 
void GetAllReflectionShaders (maxon::BaseArray< BaseShader *> &shaders)
 
void GetReflectionPrimaryLayers (Int32 &reflection_layer, Int32 &specular_layer)
 

Additional Inherited Members

- Public Member Functions inherited from BaseMaterial
BaseMaterialGetNext (void)
 
BaseMaterialGetPred (void)
 
void Update (Bool preview, Bool rttm)
 
BaseChannelGetChannel (Int32 id)
 
INITRENDERRESULT InitTextures (const InitRenderStruct &irs)
 
void UnlockTextures ()
 
void DisplaceEx (VolumeData *sd)
 
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 (void)
 
Bool HasEditorTransparency ()
 
GL_MESSAGE GlMessage (Int32 type, void *data=nullptr)
 
- Public Member Functions inherited from BaseList2D
BaseList2DGetNext (void)
 
BaseList2DGetPred (void)
 
void SetBit (Int32 mask)
 
Bool GetBit (Int32 mask) const
 
void DelBit (Int32 mask)
 
void ToggleBit (Int32 mask)
 
Int32 GetAllBits (void) const
 
void SetAllBits (Int32 bits)
 
BaseContainer GetData (void)
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance (void) const
 
BaseContainerGetDataInstance (void)
 
const BaseContainerGetDataInstanceRef (void) const
 
BaseContainerGetDataInstanceRef (void)
 
const StringGetName (void) const
 
void SetName (const String &name)
 
String GetBubbleHelp (void)
 
Bool TransferGoal (BaseList2D *dst, Bool undolink)
 
Bool TransferMarker (BaseList2D *dst) const
 
Bool Scale (Float scale)
 
Bool Edit (void)
 
void GetIcon (IconData *dat)
 
GeListHeadGetNLARoot (void)
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
const StringGetTypeName (void)
 
BaseList2DGetMain (void) const
 
void InsertTrackSorted (CTrack *track)
 
Bool AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
 
Bool RemoveEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
 
Bool FindEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
 
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
 
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
 
GeListHeadGetOverrideRoot (void)
 
BaseOverrideGetFirstOverride (void)
 
GeListHeadGetShaderRepositoryRoot (void)
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
const GeMarkerGetMarker (void) 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 (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)
 
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 (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot (void)
 
CTrackGetFirstCTrack (void)
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext (void)
 
GeListNodeGetPred (void)
 
GeListNodeGetDown (void)
 
GeListNodeGetUp (void)
 
GeListNodeGetDownLast (void)
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove (void)
 
GeListHeadGetListHead (void)
 
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 (void)
 
BaseDocumentGetDocument (void)
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated (void)
 
Int32 GetInfo (void)
 
Bool GetNBit (NBIT bit) const
 
Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
- Public Member Functions inherited from C4DAtom
Int32 GetType (void) const
 
Int32 GetRealType (void) const
 
Int32 GetDiskType (void) const
 
Bool IsInstanceOf (Int32 id) const
 
Int32 GetClassification (void) const
 
Bool Message (Int32 type, void *data=nullptr)
 
Bool MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
 
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
 
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
 
Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Bool Write (HyperFile *hf)
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf)
 
Bool GetDescription (Description *description, DESCFLAGS_DESC flags)
 
Bool GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
 
Bool SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
 
DynamicDescriptionGetDynamicDescription ()
 
Bool GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
 
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)
 

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()

Int32 GetReflectionLayerCount ( )

Retrieves the number of reflection/specular layers.

Since
R16
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.