DigitalSpaces::DIOGREBillboard Struct Reference
[Ogre]

#include <OGREInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
float	GetRotationRadian (void)
	Get the rotation of the billboard.
float	GetRotationDegree (void)
void	SetRotationRadian (float rotation)
	Set the rotation of the billboard.
void	SetRotationDegree (float rotation)
void	SetPosition (in_Vector3f *position)
	Set the position of the billboard.
void	SetPosition (float x, float y, float z)
	Set the position of the billboard.
void	GetPosition (out_Vector3f *position)
	Get the position of the billboard.
void	SetDimensions (float width, float height)
	Sets the width and height for this billboard.
void	ResetDimensions (void)
	Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own.
void	SetColour (in_Vector4f *colour)
	Sets the colour of this billboard.
void	GetColour (out_Vector4f *colour)
	Gets the colour of this billboard.
bool	HasOwnDimensions (void)
	Returns true if this billboard deviates from the BillboardSet's default dimensions (i.e.
float	GetOwnWidth (void)
	Retrieves the billboard's personal width, if hasOwnDimensions is true.
float	GetOwnHeight (void)
	Retrieves the billboard's personal width, if hasOwnDimensions is true.

---

Member Function Documentation

float DigitalSpaces::DIOGREBillboard::GetRotationRadian

(

void

)

Get the rotation of the billboard.

Remarks:

This rotation is relative to the center of the billboard.

float DigitalSpaces::DIOGREBillboard::GetRotationDegree

(

void

)

void DigitalSpaces::DIOGREBillboard::SetRotationRadian

(

float

rotation

)

Set the rotation of the billboard.

Remarks:

This rotation is relative to the center of the billboard.

void DigitalSpaces::DIOGREBillboard::SetRotationDegree

(

float

rotation

)

void DigitalSpaces::DIOGREBillboard::SetPosition

(

in_Vector3f *

position

)

Set the position of the billboard.

Remarks:

This position is relative to a point on the quad which is the billboard. Depending on the BillboardSet, this may be the center of the quad, the top-left etc. See BillboardSet::setBillboardOrigin for more info.

void DigitalSpaces::DIOGREBillboard::SetPosition	(	float	x,
		float	y,
		float	z
	)

Set the position of the billboard.

Remarks:

This position is relative to a point on the quad which is the billboard. Depending on the BillboardSet, this may be the center of the quad, the top-left etc. See BillboardSet::setBillboardOrigin for more info.

void DigitalSpaces::DIOGREBillboard::GetPosition

(

out_Vector3f *

position

)

Get the position of the billboard.

Remarks:

This position is relative to a point on the quad which is the billboard. Depending on the BillboardSet, this may be the center of the quad, the top-left etc. See BillboardSet::setBillboardOrigin for more info.

void DigitalSpaces::DIOGREBillboard::SetDimensions	(	float	width,
		float	height
	)

Sets the width and height for this billboard.

Remarks:

Note that it is most efficient for every billboard in a BillboardSet to have the same dimensions. If you choose to alter the dimensions of an individual billboard the set will be less efficient. Do not call this method unless you really need to have different billboard dimensions within the same set. Otherwise just call the BillboardSet::setDefaultDimensions method instead.

void DigitalSpaces::DIOGREBillboard::ResetDimensions

(

void

)

Resets this Billboard to use the parent BillboardSet's dimensions instead of it's own.

void DigitalSpaces::DIOGREBillboard::SetColour

(

in_Vector4f *

colour

)

Sets the colour of this billboard.

Remarks:

Billboards can be tinted based on a base colour. This allows variations in colour irresective of the base colour of the material allowing more varied billboards. The default colour is white. The tinting is effected using vertex colours.

void DigitalSpaces::DIOGREBillboard::GetColour

(

out_Vector4f *

colour

)

Gets the colour of this billboard.

bool DigitalSpaces::DIOGREBillboard::HasOwnDimensions

(

void

)

Returns true if this billboard deviates from the BillboardSet's default dimensions (i.e.

if the Billboard::setDimensions method has been called for this instance).

See also:

Billboard::setDimensions

float DigitalSpaces::DIOGREBillboard::GetOwnWidth

(

void

)

Retrieves the billboard's personal width, if hasOwnDimensions is true.

float DigitalSpaces::DIOGREBillboard::GetOwnHeight

(

void

)

Retrieves the billboard's personal width, if hasOwnDimensions is true.

---

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

• OGREInterfaces/OGREInterfaces.h