Canvas rendering a shared canvas view. More...

#include <deCanvasCanvasView.h>

Inheritance diagram for deCanvasCanvasView:

Public Types
typedef deTObjectReference< deCanvasCanvasView >	Ref
	Type holding strong reference. More...

Public Types inherited from deCanvas
enum	eBlendModes { ebmBlend , ebmAdd }
	Blend modes used to blend canvas over previous content. More...

typedef deTObjectReference< deCanvas >	Ref
	Type holding strong reference. More...

Public Types inherited from deResource
typedef deTObjectReference< deResource >	Ref
	Type holding strong reference. More...

Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
deCanvasView *	GetCanvasView () const
	Canvas view or NULL if not set. More...

void	SetCanvasView (deCanvasView *canvasView)
	Set canvas view or NULL to unset. More...

int	GetRepeatX () const
	Repeat count along X axis. More...

void	SetRepeatX (int count)
	Set repeat count along X axis. More...

int	GetRepeatY () const
	Repeat count along Y axis. More...

void	SetRepeatY (int count)
	Set repeat count along Y axis. More...

Visiting
virtual void	Visit (deCanvasVisitor &visitor)
	Visit canvas. More...

Public Member Functions inherited from deCanvas
const decPoint &	GetPosition () const
	Position in parent canvas view units. More...

void	SetPosition (const decPoint &position)
	Set position in parent canvas view units. More...

const decPoint &	GetSize () const
	Size in parent canvas view units. More...

void	SetSize (const decPoint &size)
	Set size in parent canvas view units. More...

const decTexMatrix2 &	GetTransform () const
	Transformation matrix affecting the canvas and all its content. More...

void	SetTransform (const decTexMatrix2 &transform)
	Set transformation matrix affecting the canvas and all its content. More...

const decColorMatrix &	GetColorTransform () const
	Transformation matrix affecting the canvas content color. More...

void	SetColorTransform (const decColorMatrix &transform)
	Set transformation matrix affecting the canvas content color. More...

bool	GetVisible () const
	Canvas is visible. More...

void	SetVisible (bool visible)
	Set if canvas is visible. More...

float	GetOrder () const
	Render order. Larger renders ontop of smaller. More...

void	SetOrder (float order)
	Set render order. Larger renders ontop of smaller. More...

float	GetTransparency () const
	Transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent. More...

void	SetTransparency (float transparency)
	Set transparency in the range from 0 to 1 where 1 is opaque and 0 fully transparent. More...

eBlendModes	GetBlendMode () const
	Blend mode used to blend canvas over previous content. More...

void	SetBlendMode (eBlendModes blendMode)
	Set blend mode used to blend canvas over previous content. More...

deCanvas *	GetMask () const
	Mask canvas or NULL if not set. More...

void	SetMask (deCanvas *mask)
	Set mask canvas or NULL if not set. More...

void	NotifyContentChanged ()
	Notify peers about changes to the canvas content. More...

deBaseGraphicCanvas *	GetPeerGraphic () const
	Graphic system peer object or NULL if not set. More...

void	SetPeerGraphic (deBaseGraphicCanvas *peer)
	Set graphic system peer object or NULL if not set. More...

deCanvas *	GetParentMask () const
	Parent mask or NULL if not set. More...

void	SetParentMask (deCanvas *mask)
	Set parent mask or NULL if not set. More...

deCanvasView *	GetParentView () const
	Parent view or NULL if not set. More...

void	SetParentView (deCanvasView *view)
	Set parent view or NULL if not set. More...

deCanvas *	GetLLViewPrev () const
	Previous canvas in the parent view linked list or NULL if not set. More...

void	SetLLViewPrev (deCanvas *canvas)
	Set next canvas in the parent view linked list or NULL if not set. More...

deCanvas *	GetLLViewNext () const
	Next canvas in the parent view linked list or NULL if not set. More...

void	SetLLViewNext (deCanvas *canvas)
	Set next canvas in the parent view linked list NULL if not set. More...

	deCanvas (deCanvasManager *manager)
	Create canvas. More...

Public Member Functions inherited from deResource
deResourceManager *	GetResourceManager () const
	Resource manager or NULL if resource is leaking. More...

deEngine *	GetEngine () const
	Game engine object from resource manager. More...

deResource *	GetLLManagerPrev () const
	Previous resource in the resource manager linked list. More...

void	SetLLManagerPrev (deResource *resource)
	Set next resource in the resource manager linked list. More...

deResource *	GetLLManagerNext () const
	Next resource in the resource manager linked list. More...

void	SetLLManagerNext (deResource *resource)
	Set next resource in the resource manager linked list. More...

void	MarkLeaking ()
	Marks the resource leaking. More...

	deResource (deResourceManager *resourceManager)
	Create resource. More...

Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...

void	AddReference ()
	Add reference increasing reference count by 1. More...

void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...

	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deCanvasCanvasView (deCanvasManager *manager)
	Create canvas. More...

virtual	~deCanvasCanvasView ()
	Clean up canvas. More...

Additional Inherited Members
Protected Member Functions inherited from deCanvas
virtual	~deCanvas ()
	Clean up canvas. More...

Protected Member Functions inherited from deResource
virtual	~deResource ()
	Clean up resource. More...

Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Canvas rendering a shared canvas view.

The Graphic Module takes care of rendering the canvas view once if changed for all deCanvasCanvasView using the same canvas view as well as managing the life-time of the rendered content. This is the only allowed way to reuse a canvas view in different places.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deCanvasCanvasView> deCanvasCanvasView::Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deCanvasCanvasView()

deCanvasCanvasView::deCanvasCanvasView ( deCanvasManager * manager )

Create canvas.

◆ ~deCanvasCanvasView()

virtual deCanvasCanvasView::~deCanvasCanvasView ( )

protectedvirtual

Clean up canvas.

Note: Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetCanvasView()

deCanvasView* deCanvasCanvasView::GetCanvasView ( ) const

inline

Canvas view or NULL if not set.

◆ GetRepeatX()

int deCanvasCanvasView::GetRepeatX ( ) const

inline

Repeat count along X axis.

◆ GetRepeatY()

int deCanvasCanvasView::GetRepeatY ( ) const

inline

Repeat count along Y axis.

◆ SetCanvasView()

void deCanvasCanvasView::SetCanvasView ( deCanvasView * canvasView )

Set canvas view or NULL to unset.

◆ SetRepeatX()

void deCanvasCanvasView::SetRepeatX ( int count )

Set repeat count along X axis.

Exceptions

deeInvalidParam count is less than 1.

◆ SetRepeatY()

void deCanvasCanvasView::SetRepeatY ( int count )

Set repeat count along Y axis.

Exceptions

deeInvalidParam count is less than 1.

◆ Visit()

virtual void deCanvasCanvasView::Visit ( deCanvasVisitor & visitor )

virtual

Visit canvas.

Reimplemented from deCanvas.

The documentation for this class was generated from the following file:

deCanvasCanvasView.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deCanvasCanvasView()

◆ ~deCanvasCanvasView()

Member Function Documentation

◆ GetCanvasView()

◆ GetRepeatX()

◆ GetRepeatY()

◆ SetCanvasView()

◆ SetRepeatX()

◆ SetRepeatY()

◆ Visit()