Phx::GraphicsEngine::BillboardGroup Class Reference

Interface to a BillboardGroup source. More...

#include <PhxGraphicsEngine.h>

Inheritance diagram for Phx::GraphicsEngine::BillboardGroup:

List of all members.

Public Member Functions
virtual void	material (const Ptr< const MaterialDescription > &material)=0
	Sets the material used to be used for a the Billboard during rendering.
virtual Ptr< const MaterialDescription >	material () const =0
	Returns the MaterialDescription used for the Billboard.
virtual void	billboard (int index, const Ptr< const BillboardDescription > &billboard)=0
virtual Ptr< const BillboardDescription >	billboard (int index) const =0
const String &	name (void) const
	Returns the name of this geometry, as it was set when the Geometry was created.
virtual void	setCustomParameter (int index, Vector4 parameters)=0
Protected Member Functions
void	setName (const String &name)

---

Detailed Description

Interface to a BillboardGroup source.

---

Member Function Documentation

virtual Ptr<const MaterialDescription> Phx::GraphicsEngine::BillboardGroup::material (   )  const [pure virtual]

Returns the MaterialDescription used for the Billboard. Returns: The material used when rendering the given submesh, or 0 if the standard material for that mesh will be used.

virtual void Phx::GraphicsEngine::BillboardGroup::material (  const Ptr< const MaterialDescription > &  material  )  [pure virtual]

Sets the material used to be used for a the Billboard during rendering. The materials are not directly associated to the mesh. The component names are mapped to mesh parts by the engine based on implementation-dependent interpretation of the index. Note that because of the implementation-dependence of the mapping from indices to actual mesh parts, misconfigured meshes may result in replaced textures affecting the wrong areas. Thus, if a modified material is not showing up, or is not being placed on the right part of a mesh, verify that the mesh is correctly exported and that its subparts corresponding to each material are correctly recognized by the underlying graphics engine. Parameters: material  The material to use while rendering the mesh. Note that this does not modify the mesh description itself -- only substitutes the given material during rendering for this particular Geometry.

virtual void Phx::GraphicsEngine::BillboardGroup::setCustomParameter (  int  index, Vector4  parameters )  [pure virtual]

Parameters: index  index number for parameters sent to vertex program. parameters  values sent to vertex program

---

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

• PhxGraphicsEngine.h

---