#include <c4d_basescenehook.h>

Inheritance diagram for BaseSceneHook:

[legend]

Public Types
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

	BaseSceneHook (Int32 id)

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)

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

virtual void	Remove ()

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

	~BaseSceneHook ()

Protected Member Functions inherited from BaseList2D
void	SetID (Int32 id)

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

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

virtual Int32	GetInstanceType () const

Private Member Functions
BaseSceneHook *	GetNext ()

BaseSceneHook *	GetPred ()

NodeData *	AllocData (Int32 id, Bool &known)

Int32	GetType () const

Int32	GetDiskType () const

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

virtual Bool	Write (HyperFile *hf)

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

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

Friends
class	BaseDocument

class	RootSceneHook

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

The class for plugin scene hooks. Cannot be instantiated.

Since: 17.008

Member Typedef Documentation

◆ SUPER

typedef BaseList2D SUPER

Constructor & Destructor Documentation

◆ BaseSceneHook() [1/2]

BaseSceneHook ( Int32 id )

◆ BaseSceneHook() [2/2]

BaseSceneHook ( )

protected

◆ ~BaseSceneHook()

~BaseSceneHook ( )

protected

Member Function Documentation

◆ IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32 id ) const

virtual

Reimplemented from BaseList2D.

◆ GetNext()

BaseSceneHook* GetNext ( )

private

◆ GetPred()

BaseSceneHook* GetPred ( )

private

◆ AllocData()

NodeData* AllocData	(	Int32	id,
		Bool &	known
	)

private

◆ GetType()

Int32 GetType ( ) const

privatevirtual

Gets the type of the base list.

Warning: This must be used to make sure that the derived object is really of the right type before casting it and accessing its members.

Note: Plugin nodes return their unique plugin IDs.

Returns: The type, for example Ocube.

Reimplemented from BaseList2D.

◆ GetDiskType()

Int32 GetDiskType ( ) const

privatevirtual

Gets the unique disk type of the base list.

Note: Normally this is the same as GetType() but there are exceptions.

Returns: The disk type, for example Ocube.

Reimplemented from BaseList2D.

◆ HandleSubChunk()

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

privatevirtual

Private.

Reimplemented from BaseList2D.

◆ Write()

virtual Bool Write ( HyperFile * hf )

privatevirtual

Private.

Reimplemented from BaseList2D.

◆ GetClone()

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

privatevirtual

Gets a copy of the base list.

Parameters

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

Returns: The cloned base list. The caller owns the pointed object.

Reimplemented from BaseList2D.

◆ CopyToX()

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

privatevirtual

Reimplemented from BaseList2D.

Friends And Related Function Documentation

◆ BaseDocument

friend class BaseDocument

friend

◆ RootSceneHook

friend class RootSceneHook

friend

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SUPER

Constructor & Destructor Documentation

◆ BaseSceneHook() [1/2]

◆ BaseSceneHook() [2/2]

◆ ~BaseSceneHook()

Member Function Documentation

◆ IsInstanceOf()

◆ GetNext()

◆ GetPred()

◆ AllocData()

◆ GetType()

◆ GetDiskType()

◆ HandleSubChunk()

◆ Write()

◆ GetClone()

◆ CopyToX()

Friends And Related Function Documentation

◆ BaseDocument

◆ RootSceneHook