BBSetFigure Class Reference

This subtype of Figure represents a set of billboards, squares with textures in space which are oriented relative to the camera. More...

#include <RenderTypes.h>

Inheritance diagram for BBSetFigure:

Collaboration diagram for BBSetFigure:

Public Member Functions
virtual	~BBSetFigure ()
virtual void	setDimension (real width, real height)
virtual real	getWidth () const
virtual real	getHeight () const
virtual void	setUpVector (const vec3 &v)
virtual int	numBillboards () const
virtual void	fillData (const VertexBuffer *vb, const IndexBuffer *ib, bool deferFill=false, bool doubleSided=false) throw (RenderException)
virtual void	setBillboardPos (indexval index, const vec3 &pos) throw (IndexException)
virtual void	setBillboardDir (indexval index, const vec3 &dir) throw (IndexException)
virtual void	setBillboardColor (indexval index, const color &col) throw (IndexException)
Public Member Functions inherited from Figure
virtual	~Figure ()
virtual const char *	getName ()
	Get the figure's name. More...
virtual void	setPosition (const vec3 &v)
	Set the figure's position in world space. More...
virtual void	setScale (const vec3 &v)
	Set the figure's scale values. More...
virtual void	setRotation (const rotator &r)
	Set the figure's rotation. More...
virtual void	setTransform (const transform &t)
	Set position, rotation, and scale for this figure simultaneously. More...
virtual void	setTransform (const vec3 &trans, const vec3 &scale, const rotator &rot)
	Set position, rotation, and scale for this figure simultaneously. More...
virtual vec3	getPosition (bool isDerived=false) const
	Get the figure's position in world space. More...
virtual vec3	getScale (bool isDerived=false) const
	Get the figure's scale values. More...
virtual rotator	getRotation (bool isDerived=false) const
	Get the figure's rotation. More...
virtual transform	getTransform (bool isDerived=false) const
	Get the figure's position, scale, and rotation transform. More...
virtual void	setMaterial (const char *mat) throw (RenderException)
	Set the figure's material, this must name an existing material. More...
virtual void	setMaterial (const Material *mat) throw (RenderException)
	Set's the figure's material. More...
virtual const char *	getMaterial () const
	Get the figure's material name. More...
virtual std::pair< vec3, vec3 >	getAABB () const
virtual void	setVisible (bool isVisible)
	Sets the figure's visibility. More...
virtual bool	isVisible () const
	Returns the figure's visibility state. More...
virtual bool	isTransparent () const
	Returns true if the figure includes transparent elements. More...
virtual bool	isOverlay () const
	Returns true if the figure is part of the UI overlay rather than an object in space. More...
virtual void	setTransparent (bool isTrans)
	Set the transparency state of the figure, this doesn't actually change data but affects how the renderer treates the object. More...
virtual void	setOverlay (bool isOverlay)
	Set the overlay state of the figure, this doesn't actually change data but affects how the renderer treates the object. More...
virtual void	setRenderQueue (sval queue)
	Get the render queue of this figure; queues set rendering order such that figures in lower queues are rendered first. More...
virtual sval	getRenderQueue () const
	Get the figure's render queue. More...
virtual void	setCameraVisibility (const Camera *cam, bool isVisible)
virtual void	setParent (Figure *fig)
	Set the parent of this figure, if `fig' is transformed then the transformation is applied to this figure as well. More...

Detailed Description

This subtype of Figure represents a set of billboards, squares with textures in space which are oriented relative to the camera.

Constructor & Destructor Documentation

~BBSetFigure()

virtual ~BBSetFigure ( )

inlinevirtual

Member Function Documentation

fillData()

virtual void fillData ( const VertexBuffer *  vb, const IndexBuffer *  ib, bool  deferFill = false, bool  doubleSided = false  ) throw ( RenderException )

inlinevirtual

Fill the vertex information using the given buffers, `ib' may be NULL for point figure types. If `deferFill' is true then the actual hardware buffers are filled during the next render cycle rather than immediately. In either case data is filled into local memory buffers first then copied to hardware buffers. This implies that calling this method is thread-safe if `deferFill' is true or if its implementation does nothing regardless of arguments. If `doubleSided' is true and the index buffer defined triangles, create backfaces for triangles with correct normals.

Reimplemented from Figure.

Reimplemented in OgreBBSetFigure.

getHeight()

virtual real getHeight ( ) const

inlinevirtual

Reimplemented in OgreBBSetFigure.

getWidth()

virtual real getWidth ( ) const

inlinevirtual

Reimplemented in OgreBBSetFigure.

numBillboards()

virtual int numBillboards ( ) const

inlinevirtual

Reimplemented in OgreBBSetFigure.

setBillboardColor()

virtual void setBillboardColor ( indexval  index, const color &  col  ) throw ( IndexException )

inlinevirtual

Reimplemented in OgreBBSetFigure.

setBillboardDir()

virtual void setBillboardDir ( indexval  index, const vec3 &  dir  ) throw ( IndexException )

inlinevirtual

Reimplemented in OgreBBSetFigure.

setBillboardPos()

virtual void setBillboardPos ( indexval  index, const vec3 &  pos  ) throw ( IndexException )

inlinevirtual

Reimplemented in OgreBBSetFigure.

setDimension()

virtual void setDimension ( real  width, real  height  )

inlinevirtual

Reimplemented in OgreBBSetFigure.

setUpVector()

virtual void setUpVector ( const vec3 &  v )

inlinevirtual

Reimplemented in OgreBBSetFigure.

---

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

• eidolon/renderer/RenderTypes.h