SurgSim::Graphics::TextureCubeMap Class Reference

Base class defining the interface for a Cube Map Graphics Texture. More...

#include <SurgSim/Graphics/TextureCubeMap.h>

Inheritance diagram for SurgSim::Graphics::TextureCubeMap:

Public Member Functions
virtual void	setSize (int width, int height)=0
	Sets the size of the texture, which is the same for each face of the cube. More...
virtual void	getSize (int *width, int *height) const =0
	Gets the size of the texture, which is the same for each face of the cube. More...
virtual bool	loadImageFaces (const std::string &negativeX, const std::string &positiveX, const std::string &negativeY, const std::string &positiveY, const std::string &negativeZ, const std::string &positiveZ)=0
	Loads images from files into the faces of the cube map. More...
Public Member Functions inherited from SurgSim::Graphics::Texture
	Texture ()
virtual	~Texture ()
	Destructor. More...
virtual bool	loadImage (const std::string &filePath)=0
	Loads an image into the texture from a file. More...
virtual void	clearImage ()=0
	Removes the image from the texture. More...
void	setIsPointSprite (bool value)
	Set point sprite flag on/off. More...
bool	isPointSprite () const
	Get point sprite flag state. More...

Detailed Description

Base class defining the interface for a Cube Map Graphics Texture.

A Cube Map Texture has a width and height, which is the same for each face of the cube.

Member Function Documentation

getSize()

virtual void SurgSim::Graphics::TextureCubeMap::getSize ( int *  width, int *  height  ) const

pure virtual

Gets the size of the texture, which is the same for each face of the cube.

Parameters

[out]	width	Width of the texture
[out]	height	Height of the texture

Implemented in SurgSim::Graphics::OsgTextureCubeMap.

loadImageFaces()

virtual bool SurgSim::Graphics::TextureCubeMap::loadImageFaces ( const std::string &  negativeX, const std::string &  positiveX, const std::string &  negativeY, const std::string &  positiveY, const std::string &  negativeZ, const std::string &  positiveZ  )

pure virtual

Loads images from files into the faces of the cube map.

Parameters

negativeX	Path to the image for the (-X) face
positiveX	Path to the image for the (+X) face
negativeY	Path to the image for the (-Y) face
positiveY	Path to the image for the (+Y) face
negativeZ	Path to the image for the (-Z) face
positiveZ	Path to the image for the (+Z) face

Returns

True if the image is successfully loaded, otherwise false

Implemented in SurgSim::Graphics::OsgTextureCubeMap.

setSize()

virtual void SurgSim::Graphics::TextureCubeMap::setSize ( int  width, int  height  )

pure virtual

Sets the size of the texture, which is the same for each face of the cube.

Parameters

width	Width of the texture
height	Height of the texture

Note

Use this to setup a texture as a render target rather than loading from file.

Implemented in SurgSim::Graphics::OsgTextureCubeMap.

---

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

• SurgSim/Graphics/TextureCubeMap.h