#include <c4d_basematerial.h>

Inheritance diagram for BaseMaterial:

[legend]

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 BaseMaterial *	Alloc (Int32 type)

static void	Free (BaseMaterial *&bl)

Navigation
BaseMaterial *	GetNext ()

BaseMaterial *	GetPred ()

Update Material
void	Update (Bool preview, Bool rttm)

Get Channel
BaseChannel *	GetChannel (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)

BaseBitmap *	GetPreview (Int32 flags)

RayIllumination *	GetRayIllumination ()

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 Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

BaseList2D *	GetPred ()

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

String	GetName () const

void	SetName (const maxon::String &name)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot ()

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName ()

BaseList2D *	GetMain () 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

GeListHead *	GetOverrideRoot ()

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot ()

GeListHead *	GetHiddenShaderRoot ()

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () 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)

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (BaseDocument *doc)

Bool	SetLayerObject (LayerObject *layer)

const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot ()

CTrack *	GetFirstCTrack ()

CTrack *	FindCTrack (const DescID &id)

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

GeListNode *	GetPred ()

GeListNode *	GetDown ()

GeListNode *	GetUp ()

GeListNode *	GetDownLast ()

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

GeListHead *	GetListHead ()

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)

GeListNode *	GetCustomData ()

BaseDocument *	GetDocument ()

Int32	GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)

Bool	IsDocumentRelated ()

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)

C4DAtom *	GetClone (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)

DynamicDescription *	GetDynamicDescription ()

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 BaseList2D
static BaseList2D *	Alloc (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] type The 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] bl The 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]	preview	If true the preview thumbnail will be updated.
[in]	rttm	If 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] id The 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] irs A 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]	sd	A volume data to use and modify. The caller owns the pointed VolumeData.
[in]	weights	Use 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