opensurgsim
Public Member Functions | List of all members
SurgSim::Graphics::OsgTexture3d Class Reference

OSG implementation of a 3D Texture. More...

#include <OsgTexture3d.h>

Inheritance diagram for SurgSim::Graphics::OsgTexture3d:
SurgSim::Graphics::OsgTexture SurgSim::Graphics::Texture3d SurgSim::Graphics::Texture SurgSim::Graphics::Texture

Public Member Functions

 OsgTexture3d ()
 Constructor. More...
 
virtual void setSize (int width, int height, int depth)
 Sets the size of the texture. More...
 
virtual void getSize (int *width, int *height, int *depth) const
 Gets the size of the texture. More...
 
virtual bool loadImageSlices (const std::vector< std::string > &filePaths)
 Loads images slices from files into the 3D texture. More...
 
osg::ref_ptr< osg::Texture3D > getOsgTexture3d () const
 Returns the osg::Texture3D.
 
- Public Member Functions inherited from SurgSim::Graphics::OsgTexture
virtual bool loadImage (const std::string &filePath)
 Loads an image into the texture from a file. More...
 
virtual void clearImage ()
 Removes the image from the texture.
 
osg::ref_ptr< osg::Texture > getOsgTexture () const
 Returns the osg::Texture1D.
 
- Public Member Functions inherited from SurgSim::Graphics::Texture
virtual ~Texture ()
 Destructor.
 
void setIsPointSprite (bool value)
 Set point sprite flag on/off.
 
bool isPointSprite () const
 Get point sprite flag state.
 

Additional Inherited Members

- Protected Member Functions inherited from SurgSim::Graphics::OsgTexture
 OsgTexture (osg::Texture *texture)
 Constructor. More...
 

Detailed Description

OSG implementation of a 3D Texture.

Wraps an osg::Texture3d

Constructor & Destructor Documentation

§ OsgTexture3d()

OsgTexture3d::OsgTexture3d ( )

Constructor.

Postcondition
No image is loaded in the texture.

Member Function Documentation

§ getSize()

void OsgTexture3d::getSize ( int *  width,
int *  height,
int *  depth 
) const
virtual

Gets the size of the texture.

Parameters
[out]widthWidth of the texture
[out]heightHeight of the texture
[out]depthDepth of the texture

Implements SurgSim::Graphics::Texture3d.

§ loadImageSlices()

bool OsgTexture3d::loadImageSlices ( const std::vector< std::string > &  filePaths)
virtual

Loads images slices from files into the 3D texture.

Parameters
filePathsPaths to the image files
Returns
True if the image is successfully loaded, otherwise false
Note
The slices are stacked in the order provided to create the depth of the 3D texture.

Load first slice, all others should have same properties

Load the remaining slices

Copy the slices into the 3D image, starting at depth 0

Implements SurgSim::Graphics::Texture3d.

§ setSize()

void OsgTexture3d::setSize ( int  width,
int  height,
int  depth 
)
virtual

Sets the size of the texture.

Parameters
widthWidth of the texture
heightHeight of the texture
depthDepth of the texture
Note
Use this to setup a texture as a render target rather than loading from file.

Implements SurgSim::Graphics::Texture3d.


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