#include <c4d_takesystemhook.h>

Inheritance diagram for TakeSystemHook:

[legend]

Public Types
typedef NodeData	SUPER

Public Types inherited from NodeData
typedef PrivateChunk	SUPER

Public Member Functions
virtual Bool	IsInstanceOf (cineware::Int32 id) const

	TakeSystemHook ()

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

TAKE_MODE	GetMode ()

void	SetMode (TAKE_MODE mode)

void	SetAutoSelect (Bool autoSelect)

Bool	GetAutoSelect ()

BaseTake *	GetMainTake (BaseDocument *doc)

BaseTake *	GetcurrentTake (BaseDocument *doc)

void	SetCurrentTake (BaseDocument doc, BaseTake cTake)

BaseTake *	AddTake (BaseDocument doc, const String &name, BaseTake parent, BaseTake *cloneFrom)

void	DeleteTake (BaseDocument doc, BaseTake take)

BaseLinkArray *	GetCameraList ()

BaseLinkArray *	GetRenderdataList ()

OVERRIDEENABLING	GetOverrideEnabling ()

void	SetOverrideEnabling (OVERRIDEENABLING enabling)

void	CheckTakeName (BaseTake *op)

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

Additional Inherited Members
Protected Member Functions inherited from NodeData
virtual Bool	Execute ()

virtual Int32	GetDiskType () const

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

Protected Member Functions inherited from PrivateChunk
virtual Bool	HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)

Detailed Description

The SceneHookData that handle the Takes structure and system in a document.

Member Typedef Documentation

◆ SUPER

typedef NodeData SUPER

Constructor & Destructor Documentation

◆ TakeSystemHook()

TakeSystemHook ( )

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.

◆ GetMode()

TAKE_MODE GetMode ( )

Retrieve the take system global mode, can be TAKE_MODE_MANUAL or TAKE_MODE_AUTO. This mode Affect how the user have to interact with GUI to override parameters.

Returns: The take system mode.

◆ SetMode()

void SetMode ( TAKE_MODE mode )

Define the take system global mode, can be TAKE_MODE_MANUAL or TAKE_MODE_AUTO. Just for internal use to change mode outside of the take module please use the corresponding Command. This mode affect how the user have to interact with GUI to override parameters.

Parameters

[in] mode The new mode to set.

◆ SetAutoSelect()

void SetAutoSelect ( Bool autoSelect )

Set auto selection state for the document.

Parameters

[in] autoSelect If true selected elements in Take manager will be selected also in other related managers.

◆ GetAutoSelect()

Bool GetAutoSelect ( )

Gets the state of auto selection for the document.

Returns: True if autoselect is on, otherwise false.

◆ GetMainTake()

BaseTake* GetMainTake ( BaseDocument * doc )

Retrieve a pointer to the Main take in doc. Main take is always the first under the header.

Parameters

[in] doc A valid BaseDocument.

Returns: The Main take pointer, must be !nullptr.

◆ GetcurrentTake()

BaseTake* GetcurrentTake ( BaseDocument * doc )

Retrieve a pointer to the current take in doc.

Parameters

[in] doc A valid BaseDocument.

Returns: The current take pointer, must be !nullptr.

◆ SetCurrentTake()

void SetCurrentTake	(	BaseDocument *	doc,
		BaseTake *	cTake
	)

Set the current take for this Document.

Parameters

[in]	doc	A valid BaseDocument.
[in]	cTake	The new current take for this document.

◆ AddTake()

BaseTake* AddTake	(	BaseDocument *	doc,
		const String &	name,
		BaseTake *	parent,
		BaseTake *	cloneFrom
	)

Create and insert a new take and return a pointer to it. Note: selections have to be handled manually.

Parameters

[in]	doc	A valid BaseDocument.
[in]	name	The Name or the new take if pass an empty string default name will be used.
[in]	parent	Optionally can be passed a parent take otherwise mew take will be added at the end of the list under Main.
[in]	cloneFrom	NOT SUPPORTED YET (If a another take is passed the new take will be cloned form it).

Returns: The new take pointer, must be !nullptr.

◆ DeleteTake()

void DeleteTake	(	BaseDocument *	doc,
		BaseTake *	take
	)

Delete passed take and all connected overrides, if take is the current take The main Take will be set as current.

Parameters

[in]	doc	A Valid BaseDocument.
[in]	take	The Take To be deleted.

◆ GetCameraList()

BaseLinkArray* GetCameraList ( )

Retrieve a pointer to the Global Camera list for this document. This list is useful in various part of the GUI EG context menu or combo box.

Returns: A pointer to the camera list.

◆ GetRenderdataList()

BaseLinkArray* GetRenderdataList ( )

Retrieve a pointer to the Global RenderData list for this document. This list is useful in various part of the GUI EG context menu or combo box.

Returns: A pointer to the RenderData list.

◆ GetOverrideEnabling()

OVERRIDEENABLING GetOverrideEnabling ( )

Gets the Override enabling state.

Returns: The override enabling defined in Take manager.

◆ SetOverrideEnabling()

void SetOverrideEnabling ( OVERRIDEENABLING enabling )

Define the override enabling.

Parameters

[in] enabling The overrides type to be enabled.

◆ Alloc()

static NodeData* Alloc ( )

static

◆ CheckTakeName()

void CheckTakeName ( BaseTake * op )

Member Data Documentation

◆ _takeBranchHead

RootPluginNode* _takeBranchHead

private

◆ _takeBranchName

String _takeBranchName

private

◆ _currentTake

BaseLink _currentTake

private

◆ _takeMode

TAKE_MODE _takeMode

private

◆ _showMainOverides

Bool _showMainOverides

private

◆ _treeDisplayMode

Int32 _treeDisplayMode

private

◆ _autoSelect

Bool _autoSelect

private

◆ _cameraList

BaseLinkArray _cameraList

private

◆ _renderDataList

BaseLinkArray _renderDataList

private

◆ _overrideEnabling

OVERRIDEENABLING _overrideEnabling

private

◆ _mergeCurrentTake

BaseTake* _mergeCurrentTake

private

Private Attributes
RootPluginNode *	_takeBranchHead

String	_takeBranchName

BaseLink	_currentTake

TAKE_MODE	_takeMode

Bool	_showMainOverides

Int32	_treeDisplayMode

Bool	_autoSelect

BaseLinkArray	_cameraList

BaseLinkArray	_renderDataList

OVERRIDEENABLING	_overrideEnabling

BaseTake *	_mergeCurrentTake

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SUPER

Constructor & Destructor Documentation

◆ TakeSystemHook()

Member Function Documentation

◆ IsInstanceOf()

◆ Init()

◆ Free()

◆ Read()

◆ Write()

◆ CopyToX()

◆ GetChunkLevel()

◆ GetMode()

◆ SetMode()

◆ SetAutoSelect()

◆ GetAutoSelect()

◆ GetMainTake()

◆ GetcurrentTake()

◆ SetCurrentTake()

◆ AddTake()

◆ DeleteTake()

◆ GetCameraList()

◆ GetRenderdataList()

◆ GetOverrideEnabling()

◆ SetOverrideEnabling()

◆ Alloc()

◆ CheckTakeName()

Member Data Documentation

◆ _takeBranchHead

◆ _takeBranchName

◆ _currentTake

◆ _takeMode

◆ _showMainOverides

◆ _treeDisplayMode

◆ _autoSelect

◆ _cameraList

◆ _renderDataList

◆ _overrideEnabling

◆ _mergeCurrentTake