A simple rectangular overlay. More...

Inheritance diagram for Castor3D::PanelOverlay:

Collaboration diagram for Castor3D::PanelOverlay:

Classes
class	BinaryParser
	PanelOverlay loader. More...

class	TextLoader
	PanelOverlay loader. More...

Public Member Functions
C3D_API	PanelOverlay ()
	Constructor. More...

virtual C3D_API	~PanelOverlay ()
	Destructor. More...

OverlayCategory::VertexArray const &	GetPanelVertex () const
	Retrieves the panel vertex buffer. More...

Public Member Functions inherited from Castor3D::OverlayCategory
	DECLARE_VECTOR (Vertex, Vertex)

C3D_API	OverlayCategory (eOVERLAY_TYPE p_type)
	Constructor. More...

virtual C3D_API	~OverlayCategory ()
	Destructor. More...

C3D_API void	Update ()
	Updates the overlay position, size... More...

C3D_API void	Render ()
	Draws the overlay. More...

virtual C3D_API void	SetMaterial (MaterialSPtr p_pMaterial)
	Sets the material. More...

C3D_API Castor::String const &	GetOverlayName () const
	Retrieves the overlay name. More...

C3D_API Castor::Position	GetAbsolutePosition (Castor::Size const &p_size) const
	Retrieves the absolute overlay position, in pixels. More...

C3D_API Castor::Size	GetAbsoluteSize (Castor::Size const &p_size) const
	Retrieves the absolute overlay size, in pixels. More...

C3D_API Castor::Point2d	GetAbsolutePosition () const
	Retrieves the absolute overlay position. More...

C3D_API Castor::Point2d	GetAbsoluteSize () const
	Retrieves the absolute overlay size. More...

C3D_API bool	IsSizeChanged () const

C3D_API bool	IsPositionChanged () const

virtual C3D_API bool	IsChanged () const

void	SetPosition (Castor::Point2d const &p_position)
	Sets the overlay position. More...

void	SetSize (Castor::Point2d const &p_size)
	Sets the overlay size. More...

Castor::Point2d const &	GetSize () const
	Retrieves the overlay size. More...

Castor::Point2d const &	GetPosition () const
	Retrieves the overlay position. More...

Castor::Size const &	GetPixelSize () const
	Retrieves the overlay size. More...

Castor::Position const &	GetPixelPosition () const
	Retrieves the overlay position. More...

Castor::Point2d &	GetSize ()
	Retrieves the overlay size. More...

Castor::Point2d &	GetPosition ()
	Retrieves the overlay position. More...

Castor::Size &	GetPixelSize ()
	Retrieves the overlay size. More...

Castor::Position &	GetPixelPosition ()
	Retrieves the overlay position. More...

eOVERLAY_TYPE	GetType () const
	Retrieves the overlay type. More...

bool	IsVisible () const
	Retrieves the visibility status. More...

MaterialSPtr	GetMaterial () const
	Retrieves the material. More...

int	GetIndex () const
	Retrieves the index. More...

int	GetLevel () const
	Retrieves the level. More...

Overlay const &	GetOverlay () const
	Retrieves the overlay. More...

Overlay &	GetOverlay ()
	Retrieves the overlay. More...

void	SetOverlay (Overlay *val)
	Sets the overlay. More...

void	SetVisible (bool val)
	Sets the visibility status. More...

void	SetPixelPosition (Castor::Position const &val)
	Sets the overlay position. More...

void	SetPixelSize (Castor::Size const &val)
	Sets the overlay size. More...

void	SetOrder (int p_index, int p_level)
	Sets the overlay order. More...

void	SetUV (Castor::Point4d const &val)
	Sets the overlay UV. More...

Castor::Point4d const &	GetUV () const
	Retrieves the overlay UV. More...

Static Public Member Functions
static C3D_API OverlayCategorySPtr	Create ()
	Creation function, used by the factory. More...

Protected Member Functions
virtual C3D_API void	DoRender (OverlayRendererSPtr p_renderer)
	Draws the overlay. More...

virtual C3D_API void	DoUpdateBuffer (Castor::Size const &p_size)
	Updates the vertex buffer. More...

Protected Member Functions inherited from Castor3D::OverlayCategory
Castor::Point2d	DoGetTotalSize () const

virtual void	DoUpdatePosition ()
	Updates the overlay position, taking care of wanted pixel position. More...

virtual void	DoUpdateSize ()
	Updates the overlay size, taking care of wanted pixel size. More...

virtual void	DoUpdate ()
	Updates the overlay position, size... More...

Protected Attributes
VertexArray	m_arrayVtx
	The vertex buffer data. More...

Protected Attributes inherited from Castor3D::OverlayCategory
Overlay *	m_pOverlay
	The overlay. More...

Castor::Point2d	m_position
	The relative position (to parent or screen) More...

Castor::Point2d	m_ptSize
	The relative size (to parent or screen) More...

Castor::Position	m_pxPosition
	The relative position (to parent or screen), in pixels. More...

Castor::Size	m_size
	The absolute size in pixels. More...

bool	m_visible
	The visibility. More...

MaterialWPtr	m_pMaterial
	The material used by the overlay. More...

int	m_index
	The overlay index. More...

int	m_level
	The overlay level. More...

Castor::String	m_strMatName
	The material name. More...

eOVERLAY_TYPE	m_type
	The overlay type. More...

bool	m_sizeChanged
	Tells if this overlay's size has changed. More...

bool	m_positionChanged
	Tells if this overlay's position has changed. More...

Castor::Point4d	m_uv
	The UV for the panel. More...

Detailed Description

A simple rectangular overlay.

Author: Sylvain DOREMUS

Date: 25/08/2010

Constructor & Destructor Documentation

◆ PanelOverlay()

C3D_API Castor3D::PanelOverlay::PanelOverlay ( )

Constructor.

◆ ~PanelOverlay()

virtual C3D_API Castor3D::PanelOverlay::~PanelOverlay ( )

virtual

Destructor.

Member Function Documentation

◆ Create()

static C3D_API OverlayCategorySPtr Castor3D::PanelOverlay::Create ( )

static

Creation function, used by the factory.

Returns: An overlay

◆ DoRender()

virtual C3D_API void Castor3D::PanelOverlay::DoRender ( OverlayRendererSPtr p_renderer )

protectedvirtual

Draws the overlay.

Parameters

[in] p_renderer The renderer used to draw this overlay

Implements Castor3D::OverlayCategory.

◆ DoUpdateBuffer()

virtual C3D_API void Castor3D::PanelOverlay::DoUpdateBuffer ( Castor::Size const & p_size )

protectedvirtual

Updates the vertex buffer.

Parameters

[in] p_size The render target size.

Implements Castor3D::OverlayCategory.

◆ GetPanelVertex()

OverlayCategory::VertexArray const& Castor3D::PanelOverlay::GetPanelVertex ( ) const

inline

Retrieves the panel vertex buffer.

Returns: The buffer

References m_arrayVtx.

Member Data Documentation

◆ m_arrayVtx

VertexArray Castor3D::PanelOverlay::m_arrayVtx

protected

The vertex buffer data.

Referenced by GetPanelVertex().

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

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/PanelOverlay.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes