RenderData Class Reference

#include <c4d_basedocument.h>

Inheritance diagram for RenderData:

Detailed Description

The RenderData class contains a container with all render settings. One can add multiple render data classes to a document. The active one will be used for the render.
The render settings in Cinema 4D are description based. The valid IDs are listed in drendersettings.h (open Cinema 4D render settings for more information, see drendersettings.res for the container definition).

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

 RenderData ()
 
 ~RenderData ()
 

Alloc/Free

static RenderDataAlloc (void)
 
static void Free (RenderData *&bl)
 

Navigation

RenderDataGetNext (void)
 
RenderDataGetPred (void)
 
RenderDataGetUp (void)
 
RenderDataGetDown (void)
 
RenderDataGetDownLast (void)
 

VideoPost

BaseVideoPostGetFirstVideoPost ()
 
void InsertVideoPost (BaseVideoPost *pvp, BaseVideoPost *pred=nullptr)
 
void InsertVideoPostLast (BaseVideoPost *pvp)
 

Multipass

MultipassObjectGetFirstMultipass ()
 
void InsertMultipass (MultipassObject *obj, MultipassObject *pred=nullptr)
 

Additional Inherited Members

- 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 BaseList2D
static BaseList2DAlloc (Int32 type)
 
static void Free (BaseList2D *&bl)
 

Constructor & Destructor Documentation

§ RenderData()

RenderData ( )
private

§ ~RenderData()

~RenderData ( )
private

Member Function Documentation

§ Alloc()

static RenderData* Alloc ( void  )
static

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

Returns
The allocated render data, or nullptr if the allocation failed.

§ Free()

static void Free ( RenderData *&  bl)
static

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

Parameters
[in,out]blThe render data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

§ GetNext()

RenderData* GetNext ( void  )

Gets the next render data in the list. Convenience version of GeListNode::GetNext() returning a pointer to a RenderData.

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

§ GetPred()

RenderData* GetPred ( void  )

Gets the previous render data in the list. Convenience version of GeListNode::GetPred() returning a pointer to a RenderData.

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

§ GetUp()

RenderData* GetUp ( void  )

Gets the parent render data of the list node. Convenience version of GeListNode::GetUp() returning a pointer to a RenderData.

Returns
The parent render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

§ GetDown()

RenderData* GetDown ( void  )

Gets the first child render data of the list node. Convenience version of GeListNode::GetDown() returning a pointer to a RenderData.

Returns
The first child render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

§ GetDownLast()

RenderData* GetDownLast ( void  )

Gets the last child render data of the list node. Convenience version of GeListNode::GetDownLast() returning a pointer to a RenderData.

Returns
The last child render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

§ GetFirstVideoPost()

BaseVideoPost* GetFirstVideoPost ( )

Gets the first video post of the render data.

Returns
The first video post. The render data owns the pointed video post.

§ InsertVideoPost()

void InsertVideoPost ( BaseVideoPost pvp,
BaseVideoPost pred = nullptr 
)

Inserts pvp as a video post in the render data. The insertion position can be specified with pred, inserting the video post below the specified pred video post.

Parameters
[in]pvpThe video post to insert. The render data takes over the ownership of the pointed video post.
[in]predThe optional video post to insert pvp after, or nullptr (default) to insert it first.

§ InsertVideoPostLast()

void InsertVideoPostLast ( BaseVideoPost pvp)

Inserts pvp as the last video post in the render data.

Parameters
[in]pvpThe video post to insert last. The render data takes over the ownership of the pointed video post.

§ GetFirstMultipass()

MultipassObject* GetFirstMultipass ( )

Gets the first multipass channel MultipassObject of the render data. The other multipass channels in the render data can be accessed by using the base class list functions, MultipassObject::GetNext().

Returns
The first multipass channel, or nullptr if there is no multipass channels in the render data. The render data owns the pointed multipass.

§ InsertMultipass()

void InsertMultipass ( MultipassObject obj,
MultipassObject pred = nullptr 
)

Inserts the multipass channel obj into the render data.
The insertion position can be specified with pred, inserting the multipass below the specified pred multipass. Otherwise the multipass channel is inserted at the first position in the list.

Parameters
[in]objThe multipass channel to insert. The render data takes over the ownership of the pointed multipass.
[in]predThe optional multipass to insert obj after, or nullptr (default) to insert it first.