#include <customgui_field.h>

Inheritance diagram for FieldLayer:

[legend]

Public Member Functions
	FieldLayer (Int32 id)

FIELDLAYER_FLAG	GetLayerFlags () const

void	SetLayerFlags (FIELDLAYER_FLAG flags, Bool state=true)

virtual Int32	GetDiskType () const

Int32	GetUniqueID () const

void	SetUniqueID (Int32 ID)

Bool	IsEqual (FieldLayer *comp) const

virtual Bool	Write (HyperFile *hf)

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

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

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

FieldLayer *	GetCloneFieldLayer (Bool rekurs, COPYFLAGS flags, AliasTrans *trans)

Public Member Functions inherited from PluginNode
virtual Bool	IsInstanceOf (Int32 xid) const

virtual Int64	GetInternalMemUsage () const

	PluginNode ()

	PluginNode (Int32 pId)

virtual	~PluginNode ()

virtual Int32	GetType () const

NodeData *	AllocData (Int32 id, Bool &known)

NodeData *	GetNodeDataI (Int32 index)

Bool	SetPluginID (Int32 *arr, Int32 cnt)

Bool	SetPluginID (Int32 id)

void	ValidateNth (Int32 index, Int32 t_id, Bool &known)

void	ValidatePluginData (Int32 *t_arr, Int32 t_cnt)

Bool	AllocPluginData (Int32 *ids)

void	FreePluginData ()

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

Static Public Member Functions
static FieldLayer *	Alloc (Int32 type)

static void	Free (FieldLayer *&layer)

Protected Attributes
FIELDLAYER_FLAG	_layerFlags

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

Private Attributes
FIELDLAYER_CHANNELFLAG	_layerEnableFlags

Int32	_layerBlendingMode

Int32	_uniqueID

Float	_layerStrength

BaseLink	_attemptedDocumentLink

Additional Inherited Members
Public Types inherited from PluginNode
typedef BaseList2D	SUPER

Public Types inherited from BaseList2D
typedef GeListNode	SUPER

Public Types inherited from GeListNode
typedef PrivateChunk	SUPER

Public Attributes inherited from PluginNode
PluginData *	plug

Int32	plug_cnt

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

Detailed Description

Since: R20

Constructor & Destructor Documentation

◆ FieldLayer()

FieldLayer ( Int32 id )

Member Function Documentation

◆ Alloc()

static FieldLayer* Alloc ( Int32 type )

static

Allocates a Field layer. Destroy the allocated Field layer with Free().

Parameters

[in] type The layer type.

Returns: The allocated Field layer, or nullptr if the allocation failed.

◆ Free()

static void Free ( FieldLayer *& layer )

static

Destructs Field layer allocated with Alloc().

Parameters

[in,out] layer The Field layer to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ GetLayerFlags()

FIELDLAYER_FLAG GetLayerFlags ( ) const

◆ SetLayerFlags()

void SetLayerFlags	(	FIELDLAYER_FLAG	flags,
		Bool	state = `true`
	)

◆ GetDiskType()

virtual Int32 GetDiskType ( ) const

virtual

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 PluginNode.

◆ GetUniqueID()

Int32 GetUniqueID ( ) const

◆ SetUniqueID()

void SetUniqueID ( Int32 ID )

◆ IsEqual()

Bool IsEqual ( FieldLayer * comp ) const

Query if this layer is equal to another. Used by the undo system and to update dirtiness as required.

Parameters

[in] comp The FieldLayer to compare to.

Returns: True if equal, false if not.

◆ Write()

virtual Bool Write ( HyperFile * hf )

virtual

Private.

Reimplemented from PluginNode.

◆ HandleSubChunk()

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

virtual

Private.

Reimplemented from PluginNode.

◆ CopyToX()

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

virtual

Reimplemented from PluginNode.

◆ GetClone()

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

virtual

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 PluginNode.

◆ GetCloneFieldLayer()

FieldLayer* GetCloneFieldLayer	(	Bool	rekurs,
		COPYFLAGS	flags,
		AliasTrans *	trans
	)

Member Data Documentation

◆ _layerFlags

FIELDLAYER_FLAG _layerFlags

protected

◆ _layerEnableFlags

FIELDLAYER_CHANNELFLAG _layerEnableFlags

private

◆ _layerBlendingMode

Int32 _layerBlendingMode

private

◆ _uniqueID

Int32 _uniqueID

private

◆ _layerStrength

Float _layerStrength

private

◆ _attemptedDocumentLink

BaseLink _attemptedDocumentLink

private

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FieldLayer()

Member Function Documentation

◆ Alloc()

◆ Free()

◆ GetLayerFlags()

◆ SetLayerFlags()

◆ GetDiskType()

◆ GetUniqueID()

◆ SetUniqueID()

◆ IsEqual()

◆ Write()

◆ HandleSubChunk()

◆ CopyToX()

◆ GetClone()

◆ GetCloneFieldLayer()

Member Data Documentation

◆ _layerFlags

◆ _layerEnableFlags

◆ _layerBlendingMode

◆ _uniqueID

◆ _layerStrength

◆ _attemptedDocumentLink