Billboard Resource. More...
#include <deBillboard.h>
Public Member Functions | |
Constructors and Destructors | |
| deBillboard (deBillboardManager *manager) | |
| Creates a new billboard. | |
| virtual | ~deBillboard () |
| Cleans up the billboard. | |
Management | |
| const decDVector & | GetPosition () const |
| Retrieves the position. | |
| void | SetPosition (const decDVector &position) |
| Sets the position. | |
| const decVector & | GetAxis () const |
| Retrieves the axis. | |
| void | SetAxis (const decVector &axis) |
| Sets the axis. | |
| const decVector2 & | GetSize () const |
| Retrieves the size. | |
| void | SetSize (const decVector2 &size) |
| Sets the size. | |
| const decVector2 & | GetOffset () const |
| Retrieves the offset. | |
| void | SetOffset (const decVector2 &offset) |
| Sets the offset. | |
| deSkin * | GetSkin () const |
| Retrieves the skin or NULL if not assigned. | |
| void | SetSkin (deSkin *skin) |
| Sets the skin. | |
| deDynamicSkin * | GetDynamicSkin () const |
| Retrieves the dynamic skin or NULL if not assigned. | |
| void | SetDynamicSkin (deDynamicSkin *dynamicSkin) |
| Sets the dynamic skin. | |
| bool | GetLocked () const |
| Determines if the billboard is locked. | |
| void | SetLocked (bool locked) |
| Sets the billboard is locked. | |
| bool | GetSpherical () const |
| Determines if the billboard is spherical. | |
| void | SetSpherical (bool spherical) |
| Sets if the billboard is spherical. | |
| bool | GetSizeFixedToScreen () const |
| Determines if the billboard size is fixed to the screen size. | |
| void | SetSizeFixedToScreen (bool sizeFixedToScreen) |
| Sets if the billboard size is fixed to the screen size. | |
| bool | GetVisible () const |
| Determines if the billboard is visible. | |
| void | SetVisible (bool visible) |
| Sets if the billboard is visible. | |
System Peers | |
| deBaseGraphicBillboard * | GetGraphicPeer () const |
| Retrieves the graphic system peer or NULL if not set. | |
| void | SetGraphicPeer (deBaseGraphicBillboard *peer) |
| Sets the graphic system peer or NULL if not set. | |
Linked List | |
| deWorld * | GetParentWorld () const |
| Retrieves the parent world or NULL. | |
| void | SetParentWorld (deWorld *world) |
| Sets the parent world or NULL. | |
| deBillboard * | GetLLWorldPrev () const |
| Retrieves the previous billboard in the parent world linked list. | |
| void | SetLLWorldPrev (deBillboard *billboard) |
| Sets the next billboard in the parent world linked list. | |
| deBillboard * | GetLLWorldNext () const |
| Retrieves the next billboard in the parent world linked list. | |
| void | SetLLWorldNext (deBillboard *billboard) |
| Sets the next billboard in the parent world linked list. | |
Detailed Description
Billboard Resource.
Billboards are rectangular objects that are different from components in that they are flat and oriented relative to the camera. Billboards can be locked in which case they are oriented along an axis or free in which case they are oriented around their position. Furthermore billboards are either spherical in which case they are oriented relative to the camera position or planar in which case they are oriented relative to the camera near plane. The image of the billboard is either a skin or a dynamic skin and has a 2 dimensional size as well as a 2 dimensional offset relative to the position and orientation axis. The y component of the size and offset moves along the orientation axis and therefore is aligned along the up direction in the camera view. The x component moves perpendicular to the orientation axis relative to the camera view and therefore is aligned along the right direction in the camera view. By default billboards are axis oriented with a world-up axis and are spherical.
- Version:
- 1.0
- Date:
- 2010
Constructor & Destructor Documentation
| deBillboard::deBillboard | ( | deBillboardManager * | manager ) |
Creates a new billboard.
| virtual deBillboard::~deBillboard | ( | ) | [virtual] |
Cleans up the billboard.
Member Function Documentation
| const decVector& deBillboard::GetAxis | ( | ) | const [inline] |
Retrieves the axis.
| deDynamicSkin* deBillboard::GetDynamicSkin | ( | ) | const [inline] |
Retrieves the dynamic skin or NULL if not assigned.
| deBaseGraphicBillboard* deBillboard::GetGraphicPeer | ( | ) | const [inline] |
Retrieves the graphic system peer or NULL if not set.
| deBillboard* deBillboard::GetLLWorldNext | ( | ) | const [inline] |
Retrieves the next billboard in the parent world linked list.
| deBillboard* deBillboard::GetLLWorldPrev | ( | ) | const [inline] |
Retrieves the previous billboard in the parent world linked list.
| bool deBillboard::GetLocked | ( | ) | const [inline] |
Determines if the billboard is locked.
| const decVector2& deBillboard::GetOffset | ( | ) | const [inline] |
Retrieves the offset.
| deWorld* deBillboard::GetParentWorld | ( | ) | const [inline] |
Retrieves the parent world or NULL.
| const decDVector& deBillboard::GetPosition | ( | ) | const [inline] |
Retrieves the position.
| const decVector2& deBillboard::GetSize | ( | ) | const [inline] |
Retrieves the size.
| bool deBillboard::GetSizeFixedToScreen | ( | ) | const [inline] |
Determines if the billboard size is fixed to the screen size.
| deSkin* deBillboard::GetSkin | ( | ) | const [inline] |
Retrieves the skin or NULL if not assigned.
| bool deBillboard::GetSpherical | ( | ) | const [inline] |
Determines if the billboard is spherical.
| bool deBillboard::GetVisible | ( | ) | const [inline] |
Determines if the billboard is visible.
| void deBillboard::SetAxis | ( | const decVector & | axis ) |
Sets the axis.
| void deBillboard::SetDynamicSkin | ( | deDynamicSkin * | dynamicSkin ) |
Sets the dynamic skin.
| void deBillboard::SetGraphicPeer | ( | deBaseGraphicBillboard * | peer ) |
Sets the graphic system peer or NULL if not set.
| void deBillboard::SetLLWorldNext | ( | deBillboard * | billboard ) |
Sets the next billboard in the parent world linked list.
| void deBillboard::SetLLWorldPrev | ( | deBillboard * | billboard ) |
Sets the next billboard in the parent world linked list.
| void deBillboard::SetLocked | ( | bool | locked ) |
Sets the billboard is locked.
| void deBillboard::SetOffset | ( | const decVector2 & | offset ) |
Sets the offset.
| void deBillboard::SetParentWorld | ( | deWorld * | world ) |
Sets the parent world or NULL.
| void deBillboard::SetPosition | ( | const decDVector & | position ) |
Sets the position.
| void deBillboard::SetSize | ( | const decVector2 & | size ) |
Sets the size.
| void deBillboard::SetSizeFixedToScreen | ( | bool | sizeFixedToScreen ) |
Sets if the billboard size is fixed to the screen size.
| void deBillboard::SetSkin | ( | deSkin * | skin ) |
Sets the skin.
| void deBillboard::SetSpherical | ( | bool | spherical ) |
Sets if the billboard is spherical.
| void deBillboard::SetVisible | ( | bool | visible ) |
Sets if the billboard is visible.
The documentation for this class was generated from the following file:
