LayerShaderLayer Class Reference

#include <c4d_layershaderlayer.h>

Inheritance diagram for LayerShaderLayer:

Public Member Functions
LayerShaderLayer *	GetNext ()
LayerType	GetType ()
String	GetName (BaseDocument *doc)
virtual Bool	GetParameter (Int32 id, GeData &d)
virtual Bool	SetParameter (Int32 id, const GeData &d)
virtual void	GetParameter (Int32 lItem, const DescID &id, GeData &t_data, Int32 &flags)
virtual void	SetParameter (Int32 lItem, const DescID &id, const GeData &t_data, Int32 &flags)
Public Member Functions inherited from BlendLayer
virtual	~BlendLayer ()
virtual String	GetLayerName (BaseDocument *pDoc, Bool bReset=false)=0
virtual Bool	CopyTo (BlendLayer *pDest, AliasTrans *pTrans)=0
virtual Bool	Read (HyperFile *pFile, Int32 lLevel)=0
virtual Bool	Write (HyperFile *pFile) const =0
virtual Int32	Compare (BlendLayer *pLayer)
virtual Bool	CompareStructure (BlendLayer *pLayer, Bool bCompareNames)
virtual void	ClearShaders (BaseList2D *pParent, BaseDocument *pDoc)
Bool	IsFolder ()
Bool	IsShader ()
LayerShaderLayer *	GetNext ()
Bool	GetParameter_ (Int32 lID, GeData &d)
Bool	SetParameter_ (Int32 lID, const GeData &d)
String	GetName (BaseDocument *pDoc)
LayerType	GetType ()

Additional Inherited Members
Static Public Member Functions inherited from BlendLayer
static void	Free (BlendLayer *&pLayer)
Public Attributes inherited from BlendLayer
CBlendLayers *	m_pParent
String	m_strName
LayerType	m_LayerType
Bool	m_bDirty
Bool	m_bIsSelected
Bool	m_bIsActive
Int32	m_lLayerID
Int32	m_lFlags
Int32	m_lRenderFlags
BaseBitmap *	m_pAlphaChannel
Protected Member Functions inherited from BlendLayer
	BlendLayer ()
Bool	CopyBasics (BlendLayer *pDest)
Static Protected Member Functions inherited from BlendLayer
static Bool	AllocDefaults (BlendLayer *pLayer)

Detailed Description

Represents a layer in the layer shader.
The layer shader can contain several layers of different types (shaders, folders, effects etc.).

Member Function Documentation

GetNext()

LayerShaderLayer* GetNext

(

)

Convenience method to get the next layer in the layer shader list of layers.

Returns

The next layer. The layer shader owns the pointed layer.

GetType()

LayerType GetType

(

)

Gets the layer type.

Returns

The layer type.

GetName()

String GetName

(

BaseDocument *

doc

)

Gets the name of the layer.

Parameters

[in]

doc

The document for the operation. The caller owns the pointed document.

Returns

The name of the layer.

GetParameter() [1/2]

virtual Bool GetParameter ( Int32  id, GeData &  d  )

virtual

Gets layer parameters.

Parameters

[in]	id	The ID of the parameter: For all layers: LAYER_S_PARAM_ALL For folders (TypeFolder): LAYER_S_PARAM_FOLDER For shaders (TypeShader): LAYER_S_PARAM_SHADER For brightness/contrast layers (TypeBrightnessContrast): LAYER_S_PARAM_BC For HSL layers (TypeHSL): LAYER_S_PARAM_HSL For posterize layers (TypePosterize): LAYER_S_PARAM_POSTER For colorize layers (TypeColorize): LAYER_S_PARAM_COLORIZE For clamp layers (TypeClamp): LAYER_S_PARAM_CLAMP For clip layers (TypeClip): LAYER_S_PARAM_CLIP For distorter layers (TypeDistorter): LAYER_S_PARAM_DISTORT For transform layers (TypeTransform): LAYER_S_PARAM_TRANS .
[out]	d	Assigned the parameter data.

Returns

true if the parameter could be retrieved, otherwise false.

Reimplemented from BlendLayer.

SetParameter() [1/2]

virtual Bool SetParameter ( Int32  id, const GeData &  d  )

virtual

Sets layer parameters.

Parameters

[in]	id	The ID of the parameter: For all layers: LAYER_S_PARAM_ALL For folders (TypeFolder): LAYER_S_PARAM_FOLDER For shaders (TypeShader): LAYER_S_PARAM_SHADER For brightness/contrast layers (TypeBrightnessContrast): LAYER_S_PARAM_BC For HSL layers (TypeHSL): LAYER_S_PARAM_HSL For posterize layers (TypePosterize): LAYER_S_PARAM_POSTER For colorize layers (TypeColorize): LAYER_S_PARAM_COLORIZE For clamp layers (TypeClamp): LAYER_S_PARAM_CLAMP For clip layers (TypeClip): LAYER_S_PARAM_CLIP For distorter layers (TypeDistorter): LAYER_S_PARAM_DISTORT For transform layers (TypeTransform): LAYER_S_PARAM_TRANS .
[in]	d	The parameter data.

Returns

true if the parameter could be set, otherwise false.

Reimplemented from BlendLayer.

GetParameter() [2/2]

virtual void GetParameter ( Int32  lItem, const DescID &  id, GeData &  t_data, Int32 &  flags  )

virtual

Private.

Reimplemented from BlendLayer.

SetParameter() [2/2]

virtual void SetParameter ( Int32  lItem, const DescID &  id, const GeData &  t_data, Int32 &  flags  )

virtual

Private.

Reimplemented from BlendLayer.