deDSRenderableVisitorIdentify Class Reference

Identify dynamic skin renderable visitor. More...

#include <deDSRenderableVisitorIdentify.h>

Inheritance diagram for deDSRenderableVisitorIdentify:

List of all members.

Public Types
enum	eRenderableTypes {   eptUnknown, eptValue, eptColor, eptImage,   eptRenderTarget, eptVideoFrame, eptCamera }
	Renderable types. More...
Public Member Functions
Constructors and Destructors
	deDSRenderableVisitorIdentify ()
	Creates a new visitor.
virtual	~deDSRenderableVisitorIdentify ()
	Cleans up the visitor.
Management
int	GetType () const
	Retrieves the renderable type.
bool	IsUnknown () const
	Determines if this is an unknown renderable.
bool	IsValue () const
	Determines if this is a value renderable.
bool	IsColor () const
	Determines if this is a color renderable.
bool	IsImage () const
	Determines if this is an image renderable.
bool	IsRenderTarget () const
	Determines if this is a render target renderable.
bool	IsVideoFrame () const
	Determines if this is a video frame renderable.
bool	IsCamera () const
	Determines if this is a camera renderable.
deDSRenderableValue *	CastToValue () const
	Cast to a value renderable.
deDSRenderableColor *	CastToColor () const
	Cast to a color renderable.
deDSRenderableImage *	CastToImage () const
	Cast to an image renderable.
deDSRenderableRenderTarget *	CastToRenderTarget () const
	Cast to a render target renderable.
deDSRenderableVideoFrame *	CastToVideoFrame () const
	Cast to a video frame renderable.
deDSRenderableCamera *	CastToCamera () const
	Cast to a camera renderable.
void	Reset ()
	Resets the visitor.
Visiting
virtual void	VisitRenderable (deDSRenderable *renderable)
	Visits a renderable.
virtual void	VisitValue (deDSRenderableValue *renderable)
	Visits a value renderable.
virtual void	VisitColor (deDSRenderableColor *renderable)
	Visits a color renderable.
virtual void	VisitImage (deDSRenderableImage *renderable)
	Visits an image renderable.
virtual void	VisitRenderTarget (deDSRenderableRenderTarget *renderable)
	Visits a render target renderable.
virtual void	VisitVideoFrame (deDSRenderableVideoFrame *renderable)
	Visits a video frame renderable.
virtual void	VisitCamera (deDSRenderableCamera *renderable)
	Visits a camera renderable.

---

Detailed Description

Identify dynamic skin renderable visitor.

Renderable visitor providing identification. After visiting a renderable the visitor can be queried for the kind of the visited renderable. Useful to identify renderables and to carry out actions only for certain renderable types. Furthermore save casting is provided. If the cast is not valid an exception is raised.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Member Enumeration Documentation

enum deDSRenderableVisitorIdentify::eRenderableTypes

Renderable types.

Enumerator:

eptUnknown	Unknown.
eptValue	Value.
eptColor	Color.
eptImage	Image.
eptRenderTarget	Render target.
eptVideoFrame	Video frame.
eptCamera	Camera.

---

Constructor & Destructor Documentation

deDSRenderableVisitorIdentify::deDSRenderableVisitorIdentify

(

)

Creates a new visitor.

virtual deDSRenderableVisitorIdentify::~deDSRenderableVisitorIdentify

(

)

[virtual]

Cleans up the visitor.

---

Member Function Documentation

deDSRenderableCamera* deDSRenderableVisitorIdentify::CastToCamera

(

)

const

Cast to a camera renderable.

deDSRenderableColor* deDSRenderableVisitorIdentify::CastToColor

(

)

const

Cast to a color renderable.

deDSRenderableImage* deDSRenderableVisitorIdentify::CastToImage

(

)

const

Cast to an image renderable.

deDSRenderableRenderTarget* deDSRenderableVisitorIdentify::CastToRenderTarget

(

)

const

Cast to a render target renderable.

deDSRenderableValue* deDSRenderableVisitorIdentify::CastToValue

(

)

const

Cast to a value renderable.

deDSRenderableVideoFrame* deDSRenderableVisitorIdentify::CastToVideoFrame

(

)

const

Cast to a video frame renderable.

int deDSRenderableVisitorIdentify::GetType

(

)

const [inline]

Retrieves the renderable type.

bool deDSRenderableVisitorIdentify::IsCamera

(

)

const [inline]

Determines if this is a camera renderable.

bool deDSRenderableVisitorIdentify::IsColor

(

)

const [inline]

Determines if this is a color renderable.

bool deDSRenderableVisitorIdentify::IsImage

(

)

const [inline]

Determines if this is an image renderable.

bool deDSRenderableVisitorIdentify::IsRenderTarget

(

)

const [inline]

Determines if this is a render target renderable.

bool deDSRenderableVisitorIdentify::IsUnknown

(

)

const [inline]

Determines if this is an unknown renderable.

bool deDSRenderableVisitorIdentify::IsValue

(

)

const [inline]

Determines if this is a value renderable.

bool deDSRenderableVisitorIdentify::IsVideoFrame

(

)

const [inline]

Determines if this is a video frame renderable.

void deDSRenderableVisitorIdentify::Reset

(

)

Resets the visitor.

virtual void deDSRenderableVisitorIdentify::VisitCamera

(

deDSRenderableCamera *

renderable )

[virtual]

Visits a camera renderable.

Reimplemented from deDSRenderableVisitor.

virtual void deDSRenderableVisitorIdentify::VisitColor

(

deDSRenderableColor *

renderable )

[virtual]

Visits a color renderable.

Reimplemented from deDSRenderableVisitor.

virtual void deDSRenderableVisitorIdentify::VisitImage

(

deDSRenderableImage *

renderable )

[virtual]

Visits an image renderable.

Reimplemented from deDSRenderableVisitor.

virtual void deDSRenderableVisitorIdentify::VisitRenderable

(

deDSRenderable *

renderable )

[virtual]

Visits a renderable.

Reimplemented from deDSRenderableVisitor.

virtual void deDSRenderableVisitorIdentify::VisitRenderTarget

(

deDSRenderableRenderTarget *

renderable )

[virtual]

Visits a render target renderable.

Reimplemented from deDSRenderableVisitor.

virtual void deDSRenderableVisitorIdentify::VisitValue

(

deDSRenderableValue *

renderable )

[virtual]

Visits a value renderable.

Reimplemented from deDSRenderableVisitor.

virtual void deDSRenderableVisitorIdentify::VisitVideoFrame

(

deDSRenderableVideoFrame *

renderable )

[virtual]

Visits a video frame renderable.

Reimplemented from deDSRenderableVisitor.

---

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

• deDSRenderableVisitorIdentify.h