BaseOverrideData Class Reference

#include <c4d_baseoverridedata.h>

Inheritance diagram for BaseOverrideData:

Public Types
typedef NodeData	SUPER
Public Types inherited from NodeData
typedef PrivateChunk	SUPER

Public Member Functions
virtual Bool	IsInstanceOf (cineware::Int32 id) const
	BaseOverrideData ()
	~BaseOverrideData ()
virtual Bool	Init ()
virtual void	Free ()
virtual Bool	Read (HyperFile *hf, Int32 id, Int32 level)
virtual Bool	Write (HyperFile *hf)
virtual Bool	CopyToX (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trn)
virtual Int32	GetChunkLevel ()
virtual Bool	TranslateDescID (GeListNode *node, const DescID &id, DescID &res_id, GeListNode *&res_at)
BaseList2D *	GetMainNode ()
BaseTake *	GetTakeNode (BaseDocument *doc)
Bool	SetTakeNode (BaseTake *newTake)
BaseOverrideGroup *	GetGroupLink (BaseDocument *doc)
Bool	SetGroupLink (BaseOverrideGroup *group)
Int	GetOverrideParameterCount ()
Bool	IsOverriddenParam (const DescID &pIdx)
Bool	IsAnimatedOverrideParam (const DescID &pIdx)
Bool	DeleteTrackIfAnimated (const DescID &pIdx)
Bool	OverrideParam (const OverrideDataSet &data)
GeData	GetOverrideParam (const DescID &pIdx)
Bool	RemoveOverrideParam (BaseDocument *doc, const DescID &pIdx, Bool removeEntry=true)
Bool	GetValuesFromDocument (BaseDocument *doc, NodeChange *exclude)
Bool	GetAllValuesFromDocument (BaseDocument *doc, BaseArray< OverrideMapEntry > &changed)
Bool	SendValuesToDocument (BaseDocument *doc, NodeChange *exclude, BaseList2D *toClone=nullptr)
Bool	SendAllValuesToDocument (BaseDocument *doc, BaseArray< OverrideMapEntry > &changed, BaseList2D *toClone=nullptr)
Bool	IsTakeAffected (BaseDocument *doc, BaseTake *take, const DescID &pIdx)
Bool	GetAllOverrideDescID (cineware::BaseArray< DescID > &result)
Bool	RebuildUserData (GeListNode *node)
void	AppendSubNode (BaseDocument *doc, BaseList2D *node)
Bool	HasValidSubNodes (BaseDocument *doc)
BaseList2D *	GetParentNode (BaseDocument *doc)
void	SetParentNode (BaseList2D *parent)
Public Member Functions inherited from NodeData
	NodeData ()
BaseList2D *	GetNode ()
void	SetNode (BaseList2D *ptr)
BaseTag *	GetTag (Int32 id)
BaseTag *	MakeTag (Int32 id)
Public Member Functions inherited from PrivateChunk
	PrivateChunk ()
Bool	ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
virtual Bool	IsListHead ()
virtual Int32	GetType () const
virtual Int32	GetInstanceType () const
Bool	ReadObject (HyperFile *hf, Bool readheader)
Bool	WriteObject (HyperFile *hf, Int32 type)
Bool	CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
virtual Bool	GetDParameter (const DescID &id, GeData &data)
virtual Bool	SetDParameter (const DescID &id, const GeData &data)
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)
Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
PrivateChunk *	GetNext () const
PrivateChunk *	GetPrev () const
void	InsertBefore (PrivateChunk *n)
void	InsertAfter (PrivateChunk *n)
void	Remove ()

Static Public Member Functions
static NodeData *	Alloc ()

Private Attributes
BaseArray< OverrideMapEntry >	_overrideMap
BaseLink	_takeLink
BaseLink	_groupLink
BaseLink	_parentNode
BaseLinkArray	_subNodes
BaseBitmap *	_preview

Additional Inherited Members
Protected Member Functions inherited from NodeData
virtual Bool	Execute ()
virtual Int32	GetDiskType () const
Protected Member Functions inherited from PrivateChunk
virtual Bool	HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)

Detailed Description

Node data class for BaseOverride objects.

Member Typedef Documentation

SUPER

typedef NodeData SUPER

Constructor & Destructor Documentation

BaseOverrideData()

BaseOverrideData

(

)

~BaseOverrideData()

~BaseOverrideData

(

)

Member Function Documentation

IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32  id ) const

virtual

Reimplemented from NodeData.

Init()

virtual Bool Init ( )

virtual

Called when an instance of a derived node data class needs to be initialized.

Returns

true if successful, otherwise false.

Reimplemented from NodeData.

Free()

virtual void Free ( )

virtual

Reimplemented from NodeData.

Read()

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

virtual

Reads the node from a hyper file.

Parameters

[in]	hf	The hyper file to read from. Cineware SDK owns the pointed hyper file.
[in]	id	The ID of the node to read.
[in]	level	The disklevel of the node to read.

Returns

true if successful, otherwise false.

Reimplemented from NodeData.

Write()

virtual Bool Write ( HyperFile *  hf )

virtual

Reimplemented from PrivateChunk.

CopyToX()

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

virtual

Private.

Reimplemented from NodeData.

GetChunkLevel()

virtual Int32 GetChunkLevel ( )

virtual

Reimplemented from PrivateChunk.

TranslateDescID()

virtual Bool TranslateDescID ( GeListNode *  node, const DescID &  id, DescID &  res_id, GeListNode *&  res_at  )

virtual

Private.

Reimplemented from NodeData.

GetMainNode()

BaseList2D* GetMainNode

(

)

GetTakeNode()

BaseTake* GetTakeNode

(

BaseDocument *

doc

)

SetTakeNode()

Bool SetTakeNode

(

BaseTake *

newTake

)

GetGroupLink()

BaseOverrideGroup* GetGroupLink

(

BaseDocument *

doc

)

SetGroupLink()

Bool SetGroupLink

(

BaseOverrideGroup *

group

)

GetOverrideParameterCount()

Int GetOverrideParameterCount

(

)

IsOverriddenParam()

Bool IsOverriddenParam

(

const DescID &

pIdx

)

IsAnimatedOverrideParam()

Bool IsAnimatedOverrideParam

(

const DescID &

pIdx

)

DeleteTrackIfAnimated()

Bool DeleteTrackIfAnimated

(

const DescID &

pIdx

)

OverrideParam()

Bool OverrideParam

(

const OverrideDataSet &

data

)

GetOverrideParam()

GeData GetOverrideParam

(

const DescID &

pIdx

)

RemoveOverrideParam()

Bool RemoveOverrideParam	(	BaseDocument *	doc,
		const DescID &	pIdx,
		Bool	removeEntry = true
	)

GetValuesFromDocument()

Bool GetValuesFromDocument	(	BaseDocument *	doc,
		NodeChange *	exclude
	)

GetAllValuesFromDocument()

Bool GetAllValuesFromDocument	(	BaseDocument *	doc,
		BaseArray< OverrideMapEntry > &	changed
	)

SendValuesToDocument()

Bool SendValuesToDocument	(	BaseDocument *	doc,
		NodeChange *	exclude,
		BaseList2D *	toClone = nullptr
	)

SendAllValuesToDocument()

Bool SendAllValuesToDocument	(	BaseDocument *	doc,
		BaseArray< OverrideMapEntry > &	changed,
		BaseList2D *	toClone = nullptr
	)

IsTakeAffected()

Bool IsTakeAffected	(	BaseDocument *	doc,
		BaseTake *	take,
		const DescID &	pIdx
	)

GetAllOverrideDescID()

Bool GetAllOverrideDescID

(

cineware::BaseArray< DescID > &

result

)

RebuildUserData()

Bool RebuildUserData

(

GeListNode *

node

)

AppendSubNode()

void AppendSubNode	(	BaseDocument *	doc,
		BaseList2D *	node
	)

HasValidSubNodes()

Bool HasValidSubNodes

(

BaseDocument *

doc

)

GetParentNode()

BaseList2D* GetParentNode

(

BaseDocument *

doc

)

SetParentNode()

void SetParentNode

(

BaseList2D *

parent

)

Alloc()

static NodeData* Alloc ( )

static

Member Data Documentation

_overrideMap

BaseArray<OverrideMapEntry> _overrideMap

private

_takeLink

BaseLink _takeLink

private

_groupLink

BaseLink _groupLink

private

_parentNode

BaseLink _parentNode

private

_subNodes

BaseLinkArray _subNodes

private

_preview

BaseBitmap* _preview

private