Inheritance diagram for iOverlay:

Detailed Description

Public Member Functions
virtual iOverlay *	Clone () const =0
	Clone the overlay. More...

virtual iMaterial *	GetMaterial () const =0
	Get the overlay's material. {Property}. More...

virtual iImage *	GetImage () const =0
	Get the overlay's base image if there's one. {Property}. More...

virtual sVec2f	GetBaseSize () const =0
	Get the overlay's base size. More...

virtual void	SetPivot (const sVec2f &avPivot)=0
	Set the overlay's pivot position. More...

virtual sVec2f	GetPivot () const =0
	Get the overlay's pivot position. {Property}. More...

virtual void	SetSize (sVec2f avSize)=0
	Set the overlay size. {Property}. More...

virtual sVec2f	GetSize () const =0
	Get the overlay position and size. {Property}. More...

virtual void	SetBlendMode (eBlendMode aBlendMode)=0
	Set the rasterizer blend mode. More...

virtual eBlendMode	GetBlendMode () const =0
	Get the rasterizer blend mode. {Property}. More...

virtual void	SetFiltering (tBool abEnabled)=0
	Set the filtering mode. More...

virtual tBool	GetFiltering () const =0
	Get the filtering mode. {Property}. More...

virtual void	SetColor (const sColor4f &aColor)=0
	Set the color of the overlay. {Property}. More...

virtual sColor4f	GetColor () const =0
	Get the color of the overlay. {Property}. More...

virtual void	SetCornerColor (eRectCorners aCorner, const sColor4f &aColor)=0
	Set the color of the overlay. More...

virtual sColor4f	GetCornerColor (eRectCorners aCorner) const =0
	Get the color of the overlay. More...

virtual void	SetMapping (const sRectf &aRect)=0
	Set the overlay's mapping coordinates. {Property}. More...

virtual sRectf	GetMapping () const =0
	Get the overlay's mapping coordinates. {Property}. More...

virtual void	SetFrame (const sVec4f &aFrameBorder)=0
	Set the overlay's frame. {Property}. More...

virtual sVec4f	GetFrame () const =0
	Get the overlay's frame. {Property}. More...

virtual tBool	GetIsFrame () const =0
	Get whether a frame is activated. {Property}. More...

virtual sRectf	ComputeFrameCenter (const sRectf &aDest) const =0
	Compute the center of the frame from the provided destination rectangle. More...

virtual tBool	Draw (iCanvas *apCanvas, const sVec2f &aPos, const sVec2f &aSize)=0

virtual tBool	DrawFrame (iCanvas *apCanvas, tRectFrameFlags aFrame, const sVec2f &aPos, const sVec2f &aSize)=0

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual iOverlay* Clone ( ) const

pure virtual

Clone the overlay.

virtual iMaterial* GetMaterial ( ) const

pure virtual

Get the overlay's material. {Property}.

virtual iImage* GetImage ( ) const

pure virtual

Get the overlay's base image if there's one. {Property}.

virtual sVec2f GetBaseSize ( ) const

pure virtual

Get the overlay's base size.

Remarks: The base size is the size of the overlay's material. {Property}

virtual void SetPivot ( const sVec2f & avPivot )

pure virtual

Set the overlay's pivot position.

Remarks: The pivot position, is the offset at which the overaly is going to be drawn.; If < 1.0 the center position is considered to be relative to the overlay's size, else it's assumed to be 'absolute'.; Default is (0,0), the position is relative the the top left corner of the overlay. {Property}

virtual sVec2f GetPivot ( ) const

pure virtual

Get the overlay's pivot position. {Property}.

virtual void SetSize ( sVec2f avSize )

pure virtual

Set the overlay size. {Property}.

virtual sVec2f GetSize ( ) const

pure virtual

Get the overlay position and size. {Property}.

virtual void SetBlendMode ( eBlendMode aBlendMode )

pure virtual

Set the rasterizer blend mode.

Remarks: This changes the blend mode in the material. {Property}

virtual eBlendMode GetBlendMode ( ) const

pure virtual

Get the rasterizer blend mode. {Property}.

virtual void SetFiltering ( tBool abEnabled )

pure virtual

Set the filtering mode.

Remarks: This changes the filtering type in the material. {Property}

virtual tBool GetFiltering ( ) const

pure virtual

Get the filtering mode. {Property}.

virtual void SetColor ( const sColor4f & aColor )

pure virtual

Set the color of the overlay. {Property}.

virtual sColor4f GetColor ( ) const

pure virtual

Get the color of the overlay. {Property}.

virtual void SetCornerColor	(	eRectCorners	aCorner,
		const sColor4f &	aColor
	)

pure virtual

Set the color of the overlay.

Parameters

aCorner	specify the corner(s) on which the color apply.
aColor	is the new color of the corner. {Property}

virtual sColor4f GetCornerColor ( eRectCorners aCorner ) const

pure virtual

Get the color of the overlay.

Parameters

aCorner is the corner to get the color of.

Returns: the color of the specified corner of the overlay. {Property}

virtual void SetMapping ( const sRectf & aRect )

pure virtual

Set the overlay's mapping coordinates. {Property}.

virtual sRectf GetMapping ( ) const

pure virtual

Get the overlay's mapping coordinates. {Property}.

virtual void SetFrame ( const sVec4f & aFrameBorder )

pure virtual

Set the overlay's frame. {Property}.

virtual sVec4f GetFrame ( ) const

pure virtual

Get the overlay's frame. {Property}.

virtual tBool GetIsFrame ( ) const

pure virtual

Get whether a frame is activated. {Property}.

Remarks: A frame is defined if the frame is != Vec4::Zero

virtual sRectf ComputeFrameCenter ( const sRectf & aDest ) const

pure virtual

Compute the center of the frame from the provided destination rectangle.

virtual tBool Draw	(	iCanvas *	apCanvas,
		const sVec2f &	aPos,
		const sVec2f &	aSize
	)

pure virtual

virtual tBool DrawFrame	(	iCanvas *	apCanvas,
		tRectFrameFlags	aFrame,
		const sVec2f &	aPos,
		const sVec2f &	aSize
	)

pure virtual

Detailed Description

Public Member Functions

Member Function Documentation