Decal class. More...

#include <DecalsManager.h>

Public Member Functions
	Decal (Hydrax *h, const Ogre::String &TextureName, const int &Id)
	Constructor.

	~Decal ()
	Destructor.

void	registerPass (Ogre::Pass *_Pass)
	Register the decal int the specified pass.

void	unregister ()
	Unregister from current technique.

const Ogre::String &	getTextureName () const
	Get decal texture name.

const int &	getId () const
	Get the decal Id.

Ogre::Frustum *	getProjector ()
	Get the decal projector.

Ogre::SceneNode *	getSceneNode ()
	Get the decal scene node.

Ogre::Pass *	getRegisteredPass ()
	Get the pass the decal is in.

const Ogre::Vector2 &	getPosition () const
	Get decal position.

const Ogre::Vector2 &	getSize () const
	Get decal size.

const Ogre::Radian &	getOrientation () const
	Get decal orientation.

const Ogre::Real &	getTransparency () const
	Get decal transparency.

const bool &	isVisible () const
	Is decal visile?

void	setPosition (const Ogre::Vector2 &Position)
	Set decal position.

void	setSize (const Ogre::Vector2 &Size)
	Set decal size.

void	setOrientation (const Ogre::Radian &Orientation)
	Set decal orientation.

void	setTransparency (const Ogre::Real &Transparency)
	Set decal transparency.

void	setVisible (const bool &Visible)
	Set decal visibile or not.

Private Attributes
Ogre::String	mTextureName
	Decal texture name.

int	mId
	Decal Id.

Ogre::Frustum *	mProjector
	Decal projector.

Ogre::SceneNode *	mSceneNode
	Decal scene node.

Ogre::Pass *	mRegisteredPass
	Registered pass.

Ogre::Vector2	mPosition
	Position.

Ogre::Vector2	mSize
	Size.

Ogre::Radian	mOrientation
	Orientation.

Ogre::Real	mTransparency
	Transparency.

bool	mVisible
	Is decal visible?

Hydrax *	mHydrax
	Hydrax parent pointer.

Detailed Description

Decal class.

Definition at line 42 of file DecalsManager.h.

Constructor & Destructor Documentation

◆ Decal()

Hydrax::Decal::Decal	(	Hydrax *	h,
		const Ogre::String &	TextureName,
		const int &	Id
	)

Constructor.

Parameters

h	Hydrax parent pointer
TextureName	Texture name
Id	Decal Id

Definition at line 31 of file DecalsManager.cpp.

◆ ~Decal()

Hydrax::Decal::~Decal ( )

Destructor.

Definition at line 55 of file DecalsManager.cpp.

Member Function Documentation

◆ getId()

const int & Hydrax::Decal::getId ( ) const

inline

Get the decal Id.

Returns: Decal Id

Definition at line 76 of file DecalsManager.h.

◆ getOrientation()

const Ogre::Radian & Hydrax::Decal::getOrientation ( ) const

inline

Get decal orientation.

Returns: Decal orientation

Definition at line 125 of file DecalsManager.h.

◆ getPosition()

const Ogre::Vector2 & Hydrax::Decal::getPosition ( ) const

inline

Get decal position.

Returns: Decal position

Definition at line 109 of file DecalsManager.h.

◆ getProjector()

Ogre::Frustum * Hydrax::Decal::getProjector ( )

inline

Get the decal projector.

Returns: Projector frustum

Definition at line 84 of file DecalsManager.h.

◆ getRegisteredPass()

Ogre::Pass * Hydrax::Decal::getRegisteredPass ( )

inline

Get the pass the decal is in.

Returns: Registered pass

Remarks: return NULL if decal isn't registered

Definition at line 101 of file DecalsManager.h.

◆ getSceneNode()

Ogre::SceneNode * Hydrax::Decal::getSceneNode ( )

inline

Get the decal scene node.

Returns: Decal scene node

Definition at line 92 of file DecalsManager.h.

◆ getSize()

const Ogre::Vector2 & Hydrax::Decal::getSize ( ) const

inline

Get decal size.

Returns: Decal size

Definition at line 117 of file DecalsManager.h.

◆ getTextureName()

const Ogre::String & Hydrax::Decal::getTextureName ( ) const

inline

Get decal texture name.

Returns: Decal texture name

Definition at line 68 of file DecalsManager.h.

◆ getTransparency()

const Ogre::Real & Hydrax::Decal::getTransparency ( ) const

inline

Get decal transparency.

Returns: Decal transparency

Definition at line 133 of file DecalsManager.h.

◆ isVisible()

const bool & Hydrax::Decal::isVisible ( ) const

inline

Is decal visile?

Returns: true if decal is visible

Definition at line 141 of file DecalsManager.h.

◆ registerPass()

void Hydrax::Decal::registerPass ( Ogre::Pass * _Pass )

Register the decal int the specified pass.

Parameters

_Pass Pass to be registred

Definition at line 64 of file DecalsManager.cpp.

◆ setOrientation()

void Hydrax::Decal::setOrientation ( const Ogre::Radian & Orientation )

Set decal orientation.

Parameters

Orientation Decal orientation

Definition at line 109 of file DecalsManager.cpp.

◆ setPosition()

void Hydrax::Decal::setPosition ( const Ogre::Vector2 & Position )

Set decal position.

Parameters

Position Decal position

Definition at line 92 of file DecalsManager.cpp.

◆ setSize()

void Hydrax::Decal::setSize ( const Ogre::Vector2 & Size )

Set decal size.

Parameters

Size	Decal size in world coordinates

Definition at line 99 of file DecalsManager.cpp.

◆ setTransparency()

void Hydrax::Decal::setTransparency ( const Ogre::Real & Transparency )

Set decal transparency.

Parameters

Transparency Decal transparency in [0,1] range

Remarks: 0 = Full transparent, 1 = Full opacity

Definition at line 116 of file DecalsManager.cpp.

◆ setVisible()

void Hydrax::Decal::setVisible ( const bool & Visible )

Set decal visibile or not.

Parameters

Visible true if yes, false if not

Definition at line 127 of file DecalsManager.cpp.

◆ unregister()

void Hydrax::Decal::unregister ( )

Unregister from current technique.

Definition at line 83 of file DecalsManager.cpp.

Field Documentation

◆ mHydrax

Hydrax* Hydrax::Decal::mHydrax

private

Hydrax parent pointer.

Definition at line 196 of file DecalsManager.h.

◆ mId

int Hydrax::Decal::mId

private

Decal Id.

Definition at line 176 of file DecalsManager.h.

◆ mOrientation

Ogre::Radian Hydrax::Decal::mOrientation

private

Orientation.

Definition at line 189 of file DecalsManager.h.

◆ mPosition

Ogre::Vector2 Hydrax::Decal::mPosition

private

Position.

Definition at line 185 of file DecalsManager.h.

◆ mProjector

Ogre::Frustum* Hydrax::Decal::mProjector

private

Decal projector.

Definition at line 178 of file DecalsManager.h.

◆ mRegisteredPass

Ogre::Pass* Hydrax::Decal::mRegisteredPass

private

Registered pass.

Definition at line 182 of file DecalsManager.h.

◆ mSceneNode

Ogre::SceneNode* Hydrax::Decal::mSceneNode

private

Decal scene node.

Definition at line 180 of file DecalsManager.h.

◆ mSize

Ogre::Vector2 Hydrax::Decal::mSize

private

Size.

Definition at line 187 of file DecalsManager.h.

◆ mTextureName

Ogre::String Hydrax::Decal::mTextureName

private

Decal texture name.

Definition at line 174 of file DecalsManager.h.

◆ mTransparency

Ogre::Real Hydrax::Decal::mTransparency

private

Transparency.

Definition at line 191 of file DecalsManager.h.

◆ mVisible

bool Hydrax::Decal::mVisible

private

Is decal visible?

Definition at line 193 of file DecalsManager.h.

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

source/main/gfx/hydrax/DecalsManager.h
source/main/gfx/hydrax/DecalsManager.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Decal()

◆ ~Decal()

Member Function Documentation

◆ getId()

◆ getOrientation()

◆ getPosition()

◆ getProjector()

◆ getRegisteredPass()

◆ getSceneNode()

◆ getSize()

◆ getTextureName()

◆ getTransparency()

◆ isVisible()

◆ registerPass()

◆ setOrientation()

◆ setPosition()

◆ setSize()

◆ setTransparency()

◆ setVisible()

◆ unregister()

Field Documentation

◆ mHydrax

◆ mId

◆ mOrientation

◆ mPosition

◆ mProjector

◆ mRegisteredPass

◆ mSceneNode

◆ mSize

◆ mTextureName

◆ mTransparency

◆ mVisible