BlendEffectClip Class Reference

#include <blendlayers.h>

Inheritance diagram for BlendEffectClip:

Public Member Functions
virtual	~BlendEffectClip ()
virtual String	GetLayerName (BaseDocument *pDoc, Bool bReset=false)
virtual Bool	Read (HyperFile *pFile, Int32 lLevel)
virtual Bool	Write (HyperFile *pFile) const
virtual Int32	Compare (BlendLayer *pLayer)
virtual Bool	CopyTo (BlendLayer *pDest, AliasTrans *pTrans)
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)
virtual Bool	GetParameter (Int32 lID, GeData &d)
virtual Bool	SetParameter (Int32 lID, const GeData &d)
Public Member Functions inherited from BlendLayer
virtual	~BlendLayer ()
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 ()

Static Public Member Functions
static BlendLayer *	Alloc ()
Static Public Member Functions inherited from BlendLayer
static void	Free (BlendLayer *&pLayer)

Public Attributes
Float	m_rLowClip
Float	m_rHighClip
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

Private Member Functions
	BlendEffectClip ()

Additional Inherited Members
Protected Member Functions inherited from BlendLayer
	BlendLayer ()
Bool	CopyBasics (BlendLayer *pDest)
Static Protected Member Functions inherited from BlendLayer
static Bool	AllocDefaults (BlendLayer *pLayer)

Constructor & Destructor Documentation

BlendEffectClip()

BlendEffectClip ( )

private

Default constructor.

~BlendEffectClip()

virtual ~BlendEffectClip ( )

virtual

Default destructor.

Member Function Documentation

Alloc()

static BlendLayer* Alloc ( )

static

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

Returns

The allocated clip layer, or nullptr if the allocation failed.

GetLayerName()

virtual String GetLayerName ( BaseDocument *  pDoc, Bool  bReset = false  )

virtual

Private.

Implements BlendLayer.

Read()

virtual Bool Read ( HyperFile *  pFile, Int32  lLevel  )

virtual

Reads the layer from a hyper file.

Parameters

[in]	pFile	The hyper file to read from. The caller owns the pointed hyper file.
[in]	lLevel	The disklevel of the layer to read.

Returns

true if the layer was read, otherwise false.

Implements BlendLayer.

Write()

virtual Bool Write ( HyperFile *  pFile ) const

virtual

Writes the layer to a hyper file.

Parameters

[in]

pFile

The hyper file to write to. The caller owns the pointed hyper file.

Returns

true if the layer was written, otherwise false.

Implements BlendLayer.

Compare()

virtual Int32 Compare ( BlendLayer *  pLayer )

virtual

Compares two layers.

Parameters

[in]

pLayer

The layer to compare with. The caller owns the pointed layer.

Returns

0 if the layers are identical, otherwise 1.

Reimplemented from BlendLayer.

CopyTo()

virtual Bool CopyTo ( BlendLayer *  pDest, AliasTrans *  pTrans  )

virtual

Copies all values from the layer to pDest.

Parameters

[in]	pDest	The destination layer. The caller owns the pointed layer.
[in]	pTrans	An alias translator for the operation. Can be nullptr. The caller owns the pointed alias translator.

Returns

true if the layer was copied, otherwise false.

Implements BlendLayer.

GetParameter() [1/2]

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

virtual

Private.

Reimplemented from BlendLayer.

SetParameter() [1/2]

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

virtual

Private.

Reimplemented from BlendLayer.

GetParameter() [2/2]

virtual Bool GetParameter ( Int32  lID, GeData &  d  )

virtual

Gets layer parameters.

Parameters

[in]	lID	The layer parameter ID: LAYER_S_PARAM_CLIP
[in]	d	Filled with the layer parameter value.

Returns

true if the parameter could be retrieved, otherwise false.

Reimplemented from BlendLayer.

SetParameter() [2/2]

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

virtual

Sets layer parameters.

Parameters

[in]	lID	The layer parameter ID: LAYER_S_PARAM_CLIP
[in]	d	The layer parameter value.

Returns

true if the parameter could be set, otherwise false.

Reimplemented from BlendLayer.

Member Data Documentation

m_rLowClip

Float m_rLowClip

Private.

m_rHighClip

Float m_rHighClip

Private.