---

GAUGE3D::GSprite Class Reference

Represents an object in the 3D scene. More...

#include <gauge3d/renderer/sprite.h>

Inherits GAUGE3D::GObject.

List of all members.

Public Methods
virtual	~GSprite ()
virtual void	Show ()=0
	Tells the renderer to start drawing this object whenever it is visible.
virtual void	Hide ()=0
	Tells the renderer not to draw this object at all.
virtual void	Remove ()=0
	Permenantly removes the sprite from the scene.
virtual void	Model (pGModel model)=0
	Sets the sprite's GModel.
virtual void	AnimState (GModel::pAnimState anim)=0
	Sets the animation state for the sprite's model.
virtual void	Texture (pGTexture texture)=0
	Sets the texture to apply to the model.
virtual void	Position (const GVector &position)=0
	Sets the position of the sprite.
virtual void	Angle (const GQuaternion &angle)=0
	Sets the direction that the sprite is facing. More...
virtual void	Color (float red,float green,float blue)=0
	Set the color of the sprite. (alpha unchanged). More...
virtual void	Color (float red,float green,float blue,float alpha)=0
	Set the color and alpha of the sprite.
virtual void	Color3v (const float color[])=0
	Set the color of the sprite from a three-element array. (alpha unchanged).
virtual void	Color4v (const float color[])=0
	Set the color and alpha of the sprite from a four-element array.
virtual void	Alpha (float alpha)=0
	Set the alpha of the sprite. (color unchanged).
virtual void	LightProps (float specular,float shininess,float emission)=0
	Set the reflectivity properties of the sprite. More...
virtual void	FullBright (bool fullBright)=0
	Set true to ignore lighting and render the sprite at maximum brightness.
virtual void	Scale (GCoordinate magnification)=0
	Sets a uniform scale factor for the sprite.

---

Detailed Description

Represents an object in the 3D scene.

A sprite is any independently moving object in the scene. In GAUGE, a "sprite" is not necessarily a "billboard object", although it could be. A sprite can have any geometry which can be described by a GModel.

---

Member Function Documentation

void GAUGE3D::GSprite::Angle ( const GQuaternion & angle ) [pure virtual]

Sets the direction that the sprite is facing. Remarks: Don't forget that you can convert a GAngles into a GQuaternion.

void GAUGE3D::GSprite::Color ( float red, float green, float blue ) [pure virtual]

Set the color of the sprite. (alpha unchanged). Remarks: The color is multiplied component-wise with the texture color. If you don't want any color other than the texture color to be applied, just set the color to 1.0, 1.0, 1.0, 1.0 (full white).

void GAUGE3D::GSprite::LightProps ( float specular, float shininess, float emission ) [pure virtual]

Set the reflectivity properties of the sprite. Parameters: specular   Amount of specular light to reflect. shininess   How focused teh specular highlight is. emission   The amount of light emitted from the sprite.

---

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

• gauge3d/renderer/sprite.h

---