vtkTexture Class Reference

#include <vtkTexture.h>

Inheritance diagram for vtkTexture:

[legend]

Collaboration diagram for vtkTexture:

[legend]

List of all members.

Detailed Description

handles properties associated with a texture map

vtkTexture is an object that handles loading and binding of texture maps. It obtains its data from an input image data dataset type. Thus you can create visualization pipelines to read, process, and construct textures. Note that textures will only work if texture coordinates are also defined, and if the rendering system supports texture.

Instances of vtkTexture are associated with actors via the actor's SetTexture() method. Actors can share texture maps (this is encouraged to save memory resources.)

Warning:: Currently only 2D texture maps are supported, even though the data pipeline supports 1,2, and 3D texture coordinates.
Some renderers such as OpenGL require that the texture map dimensions are a power of two in each direction. Other renderers may have similar (ridiculous) restrictions, so be careful out there... (Note: a recent change to vtk allows use of non-power of two texture maps in OpenGL. The texture is automatically resampled to a power of two in one or more directions.)

See also:: vtkActor vtkRenderer vtkOpenGLTexture

Tests:: vtkTexture (Tests)

Definition at line 64 of file vtkTexture.h.


Public Types
typedef vtkImageAlgorithm	Superclass

enum	VTKTextureBlendingMode { VTK_TEXTURE_BLENDING_MODE_NONE = 0, VTK_TEXTURE_BLENDING_MODE_REPLACE, VTK_TEXTURE_BLENDING_MODE_MODULATE, VTK_TEXTURE_BLENDING_MODE_ADD, VTK_TEXTURE_BLENDING_MODE_ADD_SIGNED, VTK_TEXTURE_BLENDING_MODE_INTERPOLATE, VTK_TEXTURE_BLENDING_MODE_SUBTRACT }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Render (vtkRenderer *ren)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual void	Load (vtkRenderer *)
vtkImageData *	GetInput ()
unsigned char *	MapScalarsToColors (vtkDataArray *scalars)

virtual int	GetRepeat ()
virtual void	SetRepeat (int)
virtual void	RepeatOn ()
virtual void	RepeatOff ()

virtual int	GetEdgeClamp ()
virtual void	SetEdgeClamp (int)
virtual void	EdgeClampOn ()
virtual void	EdgeClampOff ()

virtual int	GetInterpolate ()
virtual void	SetInterpolate (int)
virtual void	InterpolateOn ()
virtual void	InterpolateOff ()

virtual void	SetQuality (int)
virtual int	GetQuality ()
void	SetQualityToDefault ()
void	SetQualityTo16Bit ()
void	SetQualityTo32Bit ()

virtual int	GetMapColorScalarsThroughLookupTable ()
virtual void	SetMapColorScalarsThroughLookupTable (int)
virtual void	MapColorScalarsThroughLookupTableOn ()
virtual void	MapColorScalarsThroughLookupTableOff ()

void	SetLookupTable (vtkScalarsToColors *)
virtual vtkScalarsToColors *	GetLookupTable ()

virtual vtkUnsignedCharArray *	GetMappedScalars ()

void	SetTransform (vtkTransform *transform)
virtual vtkTransform *	GetTransform ()

virtual int	GetBlendingMode ()
virtual void	SetBlendingMode (int)

virtual int	GetRestrictPowerOf2ImageSmaller ()
virtual void	SetRestrictPowerOf2ImageSmaller (int)
virtual void	RestrictPowerOf2ImageSmallerOn ()
virtual void	RestrictPowerOf2ImageSmallerOff ()
Static Public Member Functions
static vtkTexture *	New ()
static int	IsTypeOf (const char *type)
static vtkTexture *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTexture ()
	~vtkTexture ()
Protected Attributes
int	Repeat
int	EdgeClamp
int	Interpolate
int	Quality
int	MapColorScalarsThroughLookupTable
vtkScalarsToColors *	LookupTable
vtkUnsignedCharArray *	MappedScalars
vtkTransform *	Transform
int	BlendingMode
int	RestrictPowerOf2ImageSmaller
int	SelfAdjustingTableRange

Member Typedef Documentation

typedef vtkImageAlgorithm vtkTexture::Superclass

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

Definition at line 68 of file vtkTexture.h.

Member Enumeration Documentation

enum vtkTexture::VTKTextureBlendingMode

Used to specify how the texture will blend its RGB and Alpha values with other textures and the fragment the texture is rendered upon. BTX

Enumerator:

VTK_TEXTURE_BLENDING_MODE_NONE
VTK_TEXTURE_BLENDING_MODE_REPLACE
VTK_TEXTURE_BLENDING_MODE_MODULATE
VTK_TEXTURE_BLENDING_MODE_ADD
VTK_TEXTURE_BLENDING_MODE_ADD_SIGNED
VTK_TEXTURE_BLENDING_MODE_INTERPOLATE
VTK_TEXTURE_BLENDING_MODE_SUBTRACT

Definition at line 163 of file vtkTexture.h.

Constructor & Destructor Documentation

vtkTexture::vtkTexture ( ) [protected]

vtkTexture::~vtkTexture ( ) [protected]

Member Function Documentation

static vtkTexture* vtkTexture::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

virtual const char* vtkTexture::GetClassName ( ) [virtual]

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

static int vtkTexture::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

virtual int vtkTexture::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

static vtkTexture* vtkTexture::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

void vtkTexture::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

virtual void vtkTexture::Render ( vtkRenderer * ren ) [virtual]

Renders a texture map. It first checks the object's modified time to make sure the texture maps Input is valid, then it invokes the Load() method.

virtual void vtkTexture::ReleaseGraphicsResources ( vtkWindow * ) [inline, virtual]

Release any graphics resources that are being consumed by this texture. The parameter window could be used to determine which graphic resources to release.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

Definition at line 79 of file vtkTexture.h.

virtual void vtkTexture::Load ( vtkRenderer * ) [inline, virtual]

Abstract interface to renderer. Each concrete subclass of vtkTexture will load its data into graphics system in response to this method invocation.

Reimplemented in vtkMesaTexture, and vtkOpenGLTexture.

Definition at line 84 of file vtkTexture.h.

virtual int vtkTexture::GetRepeat ( ) [virtual]

Turn on/off the repetition of the texture map when the texture coords extend beyond the [0,1] range.

virtual void vtkTexture::SetRepeat ( int ) [virtual]

Turn on/off the repetition of the texture map when the texture coords extend beyond the [0,1] range.

virtual void vtkTexture::RepeatOn ( ) [virtual]

Turn on/off the repetition of the texture map when the texture coords extend beyond the [0,1] range.

virtual void vtkTexture::RepeatOff ( ) [virtual]

Turn on/off the repetition of the texture map when the texture coords extend beyond the [0,1] range.

virtual int vtkTexture::GetEdgeClamp ( ) [virtual]

Turn on/off the clamping of the texture map when the texture coords extend beyond the [0,1] range. Only used when Repeat is off, and edge clamping is supported by the graphics card.

virtual void vtkTexture::SetEdgeClamp ( int ) [virtual]

Turn on/off the clamping of the texture map when the texture coords extend beyond the [0,1] range. Only used when Repeat is off, and edge clamping is supported by the graphics card.

virtual void vtkTexture::EdgeClampOn ( ) [virtual]

Turn on/off the clamping of the texture map when the texture coords extend beyond the [0,1] range. Only used when Repeat is off, and edge clamping is supported by the graphics card.

virtual void vtkTexture::EdgeClampOff ( ) [virtual]

Turn on/off the clamping of the texture map when the texture coords extend beyond the [0,1] range. Only used when Repeat is off, and edge clamping is supported by the graphics card.

virtual int vtkTexture::GetInterpolate ( ) [virtual]

Turn on/off linear interpolation of the texture map when rendering.

virtual void vtkTexture::SetInterpolate ( int ) [virtual]

Turn on/off linear interpolation of the texture map when rendering.

virtual void vtkTexture::InterpolateOn ( ) [virtual]

Turn on/off linear interpolation of the texture map when rendering.

virtual void vtkTexture::InterpolateOff ( ) [virtual]

Turn on/off linear interpolation of the texture map when rendering.

virtual void vtkTexture::SetQuality ( int ) [virtual]