RenderData Class Reference

#include <c4d_renderdata.h>

Inheritance diagram for RenderData:

Public Types
typedef BaseList4D	SUPER
Public Types inherited from BaseList4D
typedef BaseList2D	SUPER
Public Types inherited from BaseList2D
typedef GeListNode	SUPER
Public Types inherited from GeListNode
typedef PrivateChunk	SUPER

Public Member Functions
virtual Bool	IsInstanceOf (cineware::Int32 id) const
Public Member Functions inherited from BaseList4D
BaseList4D *	GetUp ()
BaseList4D *	GetDown ()
BaseList4D *	GetDownLast ()
void	InsertBefore (BaseList4D *bl)
void	InsertAfter (BaseList4D *bl)
void	InsertUnder (BaseList4D *bl)
void	InsertUnderLast (BaseList4D *bl)
virtual void	Remove ()
Public Member Functions inherited from BaseList2D
	BaseList2D ()
virtual	~BaseList2D ()
BaseList2D *	GetNext ()
BaseList2D *	GetPred ()
NodeData *	GetNodeData ()
void	SetNodeData (NodeData *data)
void	SetBit (Int32 mask)
Bool	GetBit (Int32 mask)
void	DelBit (Int32 mask)
void	ToggleBit (Int32 mask)
Int32	GetAllBits ()
void	SetAllBits (Int32 bits)
BaseContainer	GetData ()
BaseContainer *	GetDataInstance ()
BaseContainer &	GetDataInstanceRef ()
const String &	GetName ()
void	SetName (const String &new_name)
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
BaseShader *	GetFirstShader ()
Bool	InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
Bool	InsertShaderLast (BaseShader *shader)
RootCTrack *	GetCTrackRoot ()
CTrack *	GetFirstCTrack ()
CTrack *	FindCTrack (const DescID &id)
Bool	AppendCTrack (CTrack *t)
void	InsertTrackSorted (CTrack *track)
virtual Int32	GetDiskType () const
LayerObject *	GetLayerObject ()
void	SetLayerObject (LayerObject *layer)
const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)
Bool	SetLayerData (BaseDocument *doc, const LayerData &data)
DynamicDescription *	GetDynamicDescription ()
virtual Bool	IsBaseList ()
Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const
RootPluginNode *	GetOverrideRoot ()
BaseOverride *	GetFirstOverride ()
virtual Bool	TranslateDescID (const DescID &id, DescID &res_id, GeListNode *&res_at)
Public Member Functions inherited from GeListNode
	GeListNode ()
	~GeListNode ()
virtual Bool	GetNBit (Int32 bit) const
virtual Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)
BaseDocument *	GetDocument ()
virtual Int32	GetInfo ()
GeListNode *	GetPred ()
GeListNode *	GetNext ()
GeListNode *	GetUp ()
GeListNode *	GetDown ()
GeListNode *	GetDownLast ()
void	InsertBefore (GeListNode *op)
void	InsertAfter (GeListNode *op)
void	Remove ()
void	InsertUnder (GeListNode *op)
void	InsertUnderLast (GeListNode *op)
RootList2D *	GetListHead ()
Int32	GetNodeID (Int32 index=0) const
Public Member Functions inherited from PrivateChunk
	PrivateChunk ()
Bool	ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
virtual Bool	IsListHead ()
Bool	ReadObject (HyperFile *hf, Bool readheader)
Bool	WriteObject (HyperFile *hf, Int32 type)
Bool	CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
Bool	GetParameter (Int32 id, GeData &data)
Bool	SetParameter (Int32 id, const GeData &data)
Bool	GetParameter (const DescID &id, GeData &data)
Bool	SetParameter (const DescID &id, const GeData &data)
virtual Int32	GetChunkLevel ()
Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
PrivateChunk *	GetNext () const
PrivateChunk *	GetPrev () const
void	InsertBefore (PrivateChunk *n)
void	InsertAfter (PrivateChunk *n)
void	Remove ()

Protected Member Functions
	RenderData ()
Protected Member Functions inherited from BaseList4D
	BaseList4D ()
	~BaseList4D ()
Protected Member Functions inherited from BaseList2D
void	SetID (Int32 id)
virtual Int32	GetInstanceType () const

Private Attributes
RootVideoPost	mp_posteffect
RootMultipass	mp_multipass
BaseContainer	inheritance_container

Alloc/Free
virtual Int32	GetType () const
static RenderData *	Alloc ()
static void	Free (RenderData *&rd)

Navigation
RenderData *	GetNext ()
RenderData *	GetPred ()
RenderData *	GetUp ()
RenderData *	GetDown ()
RenderData *	GetDownLast ()

VideoPost List
BaseVideoPost *	GetFirstVideoPost ()
void	InsertVideoPost (BaseVideoPost *pvp, BaseVideoPost *pred)
void	InsertVideoPostLast (BaseVideoPost *pvp)

Multipass List
MultipassObject *	GetFirstMultipass ()
void	InsertMultipass (MultipassObject *pmp, MultipassObject *pred)
void	InsertMultipassLast (MultipassObject *pmp)
void	GetResolution (Float &width, Float &height, Float &pixelAspect, Float &filmAspect)
void	SetResolution (Float width, Float height, Float pixelAspect, Float filmAspect)
void	GetAnimationSettings (Int32 &fseq, Float &fps, BaseTime &start, BaseTime &end, Int32 &field)
void	SetAnimationSettings (Int32 fseq, Float fps, BaseTime start, BaseTime end, Int32 field)

Color Profile
void	SetImageColorProfileToDefaultLinearRGB ()
void	SetImageColorProfileToDefaultLinearGray ()
void	SetImageColorProfileToDefaultSRGB ()
void	SetImageColorProfileToDefaultSGray ()

Clone
virtual BaseList2D *	GetClone (COPYFLAGS flags, AliasTrans *trn)

Private
virtual Bool	CopyToX (PrivateChunk *dst, COPYFLAGS flags, AliasTrans *trn)
virtual Bool	HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
virtual Bool	Write (HyperFile *hf)
virtual Bool	GetDParameter (const DescID &id, GeData &t_data)
virtual Bool	SetDParameter (const DescID &id, const GeData &t_data)

Additional Inherited Members
Protected Attributes inherited from BaseList2D
Int32	m_id
RootShader	mp_rootshader
RootShader	mp_rootshader_hidden
RootShader	root_shader_repository
Int32	l_bitfeld
RootCTrack	mp_rootctrack
RootPluginNode	root_override
NotifyList *	notify_events
DescIdStore *	keyframestore
DescIdStore *	propstore
BaseContainer	m_bc
NodeData *	m_data
Protected Attributes inherited from GeListNode
GeAliasGoal	m_xgoal
UInt32	m_bits [4]
RootList2D *	t_rootlist_parent
RootList2D *	m_children
BaseDocument *	parent_doc
void *	unknownData
Int	unknownDataSize
Int32	unknownDataLevel
Int32	pluginID

Detailed Description

Contains a container with all the render settings/options.
Several render data instances can be added to a document. The active one will be used for rendering.

Note

Has to be created with Alloc() and destroyed with Free().

See also

Cinema 4D Render Settings dialog and its documentation for more information. Render settings in Cinema 4D are description based and are defined in parameter_ids\drendersettings.h

Member Typedef Documentation

SUPER

typedef BaseList4D SUPER

Constructor & Destructor Documentation

RenderData()

RenderData ( )

protected

Member Function Documentation

IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32  id ) const

virtual

Reimplemented from BaseList4D.

Alloc()

static RenderData* Alloc ( )

static

Allocates a render data. Destroy the allocated render data with Free().

Returns

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

Free()

static void Free ( RenderData *&  rd )

static

Destructs render data allocated with Alloc().

Parameters

[in,out]

rd

The render data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

GetType()

virtual Int32 GetType ( ) const

virtual

Gets the object type for a render data.

Note

Always returns Rbase.

Returns

The object type for a RenderData.

Reimplemented from BaseList2D.

GetNext()

RenderData* GetNext

(

)

Gets the next render data in the list.

Returns

The next render data, or nullptr if there is none. Cineware SDK owns the pointed render data.

GetPred()

RenderData* GetPred

(

)

Gets the previous render data in the list.

Returns

The previous render data, or nullptr if there is none. Cineware SDK owns the pointed render data.

GetUp()

RenderData* GetUp

(

)

Gets the parent render data of the list node.

Returns

The parent render data, or nullptr if there is none. Cineware SDK owns the pointed render data.

GetDown()

RenderData* GetDown

(

)

Gets the first child render data of the list node.

Returns

The first child render data, or nullptr if there is none. Cineware SDK owns the pointed render data.

GetDownLast()

RenderData* GetDownLast

(

)

Gets the last child render data of the list node.

Returns

The last child render data, or nullptr if there is none. Cineware SDK owns the pointed render data.

GetFirstVideoPost()

BaseVideoPost* GetFirstVideoPost

(

)

Gets the first video post of the render settings.

Returns

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

InsertVideoPost()

void InsertVideoPost	(	BaseVideoPost *	pvp,
		BaseVideoPost *	pred
	)

Inserts video post pvp into the render settings.
The insertion position can be specified by the pred parameter, inserting video post pvp below it.

Parameters

[in]	pvp	The video post to insert. The render data takes over the ownership of the pointed video post.
[in]	pred	The video post to insert pvp after, or nullptr to insert it first. The caller owns the pointed video post.

InsertVideoPostLast()

void InsertVideoPostLast

(

BaseVideoPost *

pvp

)

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

Parameters

[in]

pvp

The video post to insert. The render data takes over the ownership of the pointed video post.

GetFirstMultipass()

MultipassObject* GetFirstMultipass

(

)

Gets the first multipass channel of the render settings.
.

Returns

The first multipass channel, or nullptr if no multipass channels are contained in the render setting. The render data owns the pointed multipass channel.

InsertMultipass()

void InsertMultipass	(	MultipassObject *	pmp,
		MultipassObject *	pred
	)

Inserts multipass channel pmp into the render settings.
The insertion position can be specified by the pred parameter, inserting multipass channel pmp below it.

Parameters

[in]	pmp	The multipass channel to insert. The render data takes over the ownership of the pointed object.
[in]	pred	The multipass channel to insert pvp after, or nullptr to insert it first. The caller owns the pointed multipass channel.

InsertMultipassLast()

void InsertMultipassLast

(

MultipassObject *

pmp

)

Inserts pmp as last the multipass channel into the render settings.

Parameters

[in]

pmp

The multipass channel to insert. The render data takes over the ownership of the pointed multipass channel.

GetResolution()

void GetResolution	(	Float &	width,
		Float &	height,
		Float &	pixelAspect,
		Float &	filmAspect
	)

Gets the resolution and aspect ratio of the render settings.

Parameters

[out]	width	Assigned the render width.
[out]	height	Assigned the render height.
[out]	pixelAspect	Assigned the pixel aspect ratio.
[out]	filmAspect	Assigned the film aspect ratio.

SetResolution()

void SetResolution	(	Float	width,
		Float	height,
		Float	pixelAspect,
		Float	filmAspect
	)

Sets the resolution and aspect ratio of the render settings.

Parameters

[in]	width	The render width to set.
[in]	height	The render height to set.
[in]	pixelAspect	The render pixel aspect ratio to set.
[in]	filmAspect	The render film aspect ratio to set.

GetAnimationSettings()

void GetAnimationSettings	(	Int32 &	fseq,
		Float &	fps,
		BaseTime &	start,
		BaseTime &	end,
		Int32 &	field
	)

Gets the animation settings of the render data.

Parameters

[out]	fseq	Assigned the frame sequence: RDATA_FRAMESEQUENCE.
[out]	fps	Assigned the frame rate (Frames per Second).
[out]	start	Assigned the start time.
[out]	end	Assigned the end time.
[out]	field	Assigned the interlace field: RDATA_FIELD.

SetAnimationSettings()

void SetAnimationSettings	(	Int32	fseq,
		Float	fps,
		BaseTime	start,
		BaseTime	end,
		Int32	field
	)

Sets the animation settings of the render data.

Parameters

[in]	fseq	The frame sequence to set set: RDATA_FRAMESEQUENCE.
[in]	fps	The frame rate (Frames per Second) to set.
[in]	start	The start time to set.
[in]	end	The end time to set.
[in]	field	The interlace field to set: RDATA_FIELD.

SetImageColorProfileToDefaultLinearRGB()

void SetImageColorProfileToDefaultLinearRGB

(

)

Sets the RenderData to use Cinema 4D default linear color profile.

SetImageColorProfileToDefaultLinearGray()

void SetImageColorProfileToDefaultLinearGray

(

)

Sets the RenderData to use Cinema 4D default linear grayscale color profile.

SetImageColorProfileToDefaultSRGB()

void SetImageColorProfileToDefaultSRGB

(

)

Sets the RenderData to use Cinema 4D default sRGB color profile.

SetImageColorProfileToDefaultSGray()

void SetImageColorProfileToDefaultSGray

(

)

Sets the RenderData to use Cinema 4D default sRGB grayscale color profile.

GetClone()

virtual BaseList2D* GetClone ( COPYFLAGS  flags, AliasTrans *  trn  )

virtual

Gets a clone/copy of the render data.

Parameters

[in]	flags	Flags for the clone.
[in]	trn	An alias translator for the operation. Can be nullptr. The caller owns the pointed alias translator.

Returns

The cloned render data. The caller owns the pointed render data.

Reimplemented from BaseList2D.

CopyToX()

virtual Bool CopyToX ( PrivateChunk *  dst, COPYFLAGS  flags, AliasTrans *  trn  )

virtual

Private.

Reimplemented from BaseList2D.

HandleSubChunk()

virtual Bool HandleSubChunk ( HyperFile *  hf, Int32  id, Int32  level  )

virtual

Private.

Reimplemented from BaseList4D.

Write()

virtual Bool Write ( HyperFile *  hf )

virtual

Private.

Reimplemented from BaseList4D.

GetDParameter()

virtual Bool GetDParameter ( const DescID &  id, GeData &  t_data  )

virtual

Private.

Reimplemented from BaseList2D.

SetDParameter()

virtual Bool SetDParameter ( const DescID &  id, const GeData &  t_data  )

virtual

Private.

Reimplemented from BaseList2D.

Member Data Documentation

mp_posteffect

RootVideoPost mp_posteffect

private

mp_multipass

RootMultipass mp_multipass

private

inheritance_container

BaseContainer inheritance_container

private