Phx::GraphicsEngine::SkyBox Class Reference

Interface to a sky box source. More...

#include <PhxGraphicsEngine.h>

Inheritance diagram for Phx::GraphicsEngine::SkyBox:

List of all members.

Public Member Functions
virtual void	mesh (const Ptr< const MeshDescription > &mesh)=0
	Sets the mesh that is attached to this Geometry.
virtual Ptr< const MeshDescription >	mesh (void) const =0
	Returns the current description of the mesh for this geometry.
virtual void	material (uint32_t index, const Ptr< const MaterialDescription > &material)=0
	Sets the material used to be used for a particular portion of the model during rendering.
virtual Ptr< const MaterialDescription >	material (uint32_t index) const =0
	Returns the MaterialDescription used for the part of the mesh corresponding to the given index.
const String &	name (void) const
	Returns the name of this geometry, as it was set when the Geometry was created.
virtual void	setCustomParameter (int subEntity, int index, Vector4 parameters)=0
Protected Member Functions
void	setName (const String &name)

---

Detailed Description

Interface to a sky box source.

---

Member Function Documentation

virtual Ptr<const MaterialDescription> Phx::GraphicsEngine::SkyBox::material (  uint32_t  index  )  const [pure virtual]

Returns the MaterialDescription used for the part of the mesh corresponding to the given index. Parameters: index  The index of the mesh part whose material is sought. 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::SkyBox::material (  uint32_t  index, const Ptr< const MaterialDescription > &  material )  [pure virtual]

Sets the material used to be used for a particular portion of the model 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: index  An integer index for the mesh component whose material is to be replaced with the given description. Note that if index is not an index used in the current mesh, it is not an error and the setting will be kept. If the mesh is later replaced, the material may still get used. 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::SkyBox::mesh (  const Ptr< const MeshDescription > &  mesh  )  [pure virtual]

Sets the mesh that is attached to this Geometry. Parameters: mesh  A description of the mesh to be rendered for this geometry. If this is 0, this geometry is skipped during rendering.

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

Parameters: subEntity  Material index... 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

---