iBillboardManager Struct Reference
This is a manager to handle billboards. More...
#include <tools/billboard.h>
Public Member Functions | |
virtual int | BillboardToScreenX (int x) const =0 |
Convert a billboard X position to screen space. | |
virtual int | BillboardToScreenY (int y) const =0 |
Convert a billboard Y position to screen space. | |
virtual iBillboard * | CreateBillboard (const char *name)=0 |
Create a new billboard with the given name. | |
virtual iBillboardLayer * | CreateBillboardLayer (const char *name)=0 |
Create a new billboard layer with the given name. | |
virtual iBillboard * | FindBillboard (const char *name) const =0 |
Find a billboard with a given name. | |
virtual iBillboardLayer * | FindBillboardLayer (const char *name) const =0 |
Find a billboard layer with a given name. | |
virtual iBillboard * | GetBillboard (size_t idx) const =0 |
Get a billboard by index. | |
virtual size_t | GetBillboardCount () const =0 |
Get the number of all billboards. | |
virtual iBillboardLayer * | GetBillboardLayer (size_t idx) const =0 |
Get a billboard layer by index. | |
virtual size_t | GetBillboardLayerCount () const =0 |
Get the number of all billboard layers. | |
virtual const csColor & | GetDefaultTextBgColor () const =0 |
Get the default background color to use for text. | |
virtual const csColor & | GetDefaultTextFgColor () const =0 |
Get the default foreground color to use for text. | |
virtual const char * | GetDefaultTextFont () const =0 |
Get the default font to use for text. | |
virtual float | GetDefaultTextFontSize () const =0 |
Get the default font size to use for text. | |
virtual iSector * | GetShowroom ()=0 |
Get the showroom. | |
virtual void | RemoveAll ()=0 |
Remove all billboards. | |
virtual void | RemoveBillboard (iBillboard *billboard)=0 |
Remove a billboard. | |
virtual void | RemoveBillboardLayer (iBillboardLayer *layer)=0 |
Remove a billboard layer. | |
virtual int | ScreenToBillboardX (int x) const =0 |
Convert a screen X position to billboard space. | |
virtual int | ScreenToBillboardY (int y) const =0 |
Convert a screen Y position to billboard space. | |
virtual void | SetDefaultTextBgColor (const csColor &color)=0 |
Setup the default background color to use for text. | |
virtual void | SetDefaultTextBgTransparent ()=0 |
Setup the default text background to use transparency. | |
virtual void | SetDefaultTextFgColor (const csColor &color)=0 |
Setup the default foreground color to use for text. | |
virtual bool | SetDefaultTextFont (const char *fontname, float fontsize)=0 |
Setup the default font to use for text. | |
virtual void | SetFlags (uint32 flags, uint32 mask)=0 |
Set flags for all billboards. | |
virtual void | StackAfter (iBillboard *bb, iBillboard *other)=0 |
Put a billboard after the given other billboard. | |
virtual void | StackBefore (iBillboard *bb, iBillboard *other)=0 |
Put a billboard before the given other billboard. | |
virtual void | StackBottom (iBillboard *bb)=0 |
Bring a billboard to the bottom of the stack. | |
virtual void | StackDown (iBillboard *bb)=0 |
Bring a billboard one closer to the bottom. | |
virtual void | StackTop (iBillboard *bb)=0 |
Bring a billboard to the top of the stack (first visible). | |
virtual void | StackUp (iBillboard *bb)=0 |
Bring a billboard one closer to the top. | |
virtual bool | TestCollision (iBillboard *bb1, iBillboard *bb2)=0 |
Test if two billboards collide with each other and return true if they do. |
Detailed Description
This is a manager to handle billboards.This is used in combination with the billboard property class.
Definition at line 389 of file billboard.h.
Member Function Documentation
|
Convert a billboard X position to screen space.
|
|
Convert a billboard Y position to screen space.
|
|
Create a new billboard with the given name. Returns 0 on failure. By default a new billboard will be visible and not movable. |
|
Create a new billboard layer with the given name. Returns 0 on failure. Note that there is always a layer with name 'default' which is used for new billboards. |
|
Find a billboard with a given name.
|
|
Find a billboard layer with a given name.
|
|
Get a billboard by index.
|
|
Get the number of all billboards.
|
|
Get a billboard layer by index.
|
|
Get the number of all billboard layers.
|
|
Get the default background color to use for text.
|
|
Get the default foreground color to use for text.
|
|
Get the default font to use for text.
|
|
Get the default font size to use for text.
|
|
Get the showroom. This is a special sector that is used for rendering meshes in. If you call this function for the first time it will create a sector with two white lights (one at (-10, 3, 0) and one at (10, 3, 0) with radius 50. The object will be placed at (0,0,0). You can modify this sector freely (adding/removing lights, changing renderloop, ...) |
|
Remove all billboards.
|
|
Remove a billboard.
|
|
Remove a billboard layer. Note that all billboards that use this layer will be put back on the default layer. Also note that you can't remove the default layer. |
|
Convert a screen X position to billboard space.
|
|
Convert a screen Y position to billboard space.
|
|
Setup the default background color to use for text.
|
|
Setup the default text background to use transparency.
|
|
Setup the default foreground color to use for text.
|
|
Setup the default font to use for text.
|
|
Set flags for all billboards.
|
|
Put a billboard after the given other billboard.
|
|
Put a billboard before the given other billboard.
|
|
Bring a billboard to the bottom of the stack.
|
|
Bring a billboard one closer to the bottom.
|
|
Bring a billboard to the top of the stack (first visible).
|
|
Bring a billboard one closer to the top.
|
|
Test if two billboards collide with each other and return true if they do.
|
The documentation for this struct was generated from the following file:
- tools/billboard.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.6