VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImplicitTextureCoords Class Reference

generate 1D, 2D, or 3D texture coordinates based on implicit function(s) More...

#include <vtkImplicitTextureCoords.h>

Inheritance diagram for vtkImplicitTextureCoords:
[legend]
Collaboration diagram for vtkImplicitTextureCoords:
[legend]

List of all members.

Public Types

typedef vtkDataSetAlgorithm Superclass
- Public Types inherited from vtkDataSetAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetRFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetRFunction ()
virtual void SetSFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetSFunction ()
virtual void SetTFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetTFunction ()
virtual void SetFlipTexture (int)
virtual int GetFlipTexture ()
virtual void FlipTextureOn ()
virtual void FlipTextureOff ()
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataObjectGetInput ()
vtkPolyDataGetPolyDataOutput ()
vtkStructuredPointsGetStructuredPointsOutput ()
vtkImageDataGetImageDataOutput ()
vtkStructuredGridGetStructuredGridOutput ()
vtkUnstructuredGridGetUnstructuredGridOutput ()
vtkRectilinearGridGetRectilinearGridOutput ()
vtkDataSetGetOutput ()
vtkDataSetGetOutput (int)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void SetInput (vtkDataSet *)
void SetInput (int, vtkDataSet *)
void AddInput (vtkDataObject *)
void AddInput (vtkDataSet *)
void AddInput (int, vtkDataSet *)
void AddInput (int, vtkDataObject *)
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImplicitTextureCoordsSafeDownCast (vtkObject *o)
static vtkImplicitTextureCoordsNew ()

Protected Member Functions

 vtkImplicitTextureCoords ()
 ~vtkImplicitTextureCoords ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkDataSetAlgorithm
 vtkDataSetAlgorithm ()
 ~vtkDataSetAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
vtkDataObjectGetInput (int port)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkImplicitFunctionRFunction
vtkImplicitFunctionSFunction
vtkImplicitFunctionTFunction
int FlipTexture

Detailed Description

generate 1D, 2D, or 3D texture coordinates based on implicit function(s)

vtkImplicitTextureCoords is a filter to generate 1D, 2D, or 3D texture coordinates from one, two, or three implicit functions, respectively. In combinations with a vtkBooleanTexture map (or another texture map of your own creation), the texture coordinates can be used to highlight (via color or intensity) or cut (via transparency) dataset geometry without any complex geometric processing. (Note: the texture coordinates are referred to as r-s-t coordinates.)

The texture coordinates are automatically normalized to lie between (0,1). Thus, no matter what the implicit functions evaluate to, the resulting texture coordinates lie between (0,1), with the zero implicit function value mapped to the 0.5 texture coordinates value. Depending upon the maximum negative/positive implicit function values, the full (0,1) range may not be occupied (i.e., the positive/negative ranges are mapped using the same scale factor).

A boolean variable InvertTexture is available to flip the texture coordinates around 0.5 (value 1.0 becomes 0.0, 0.25->0.75). This is equivalent to flipping the texture map (but a whole lot easier).

Warning:
You can use the transformation capabilities of vtkImplicitFunction to orient, translate, and scale the implicit functions. Also, the dimension of the texture coordinates is implicitly defined by the number of implicit functions defined.
See also:
vtkImplicitFunction vtkTexture vtkBooleanTexture vtkTransformTexture
Tests:
vtkImplicitTextureCoords (Tests)

Definition at line 58 of file vtkImplicitTextureCoords.h.


Member Typedef Documentation

Reimplemented from vtkDataSetAlgorithm.

Definition at line 61 of file vtkImplicitTextureCoords.h.


Constructor & Destructor Documentation

vtkImplicitTextureCoords::vtkImplicitTextureCoords ( )
protected
vtkImplicitTextureCoords::~vtkImplicitTextureCoords ( )
protected

Member Function Documentation

virtual const char* vtkImplicitTextureCoords::GetClassName ( )
virtual

Reimplemented from vtkDataSetAlgorithm.

static int vtkImplicitTextureCoords::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkImplicitTextureCoords::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

static vtkImplicitTextureCoords* vtkImplicitTextureCoords::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkDataSetAlgorithm.

void vtkImplicitTextureCoords::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 vtkDataSetAlgorithm.

static vtkImplicitTextureCoords* vtkImplicitTextureCoords::New ( )
static

Create object with texture dimension=2 and no r-s-t implicit functions defined and FlipTexture turned off.

Reimplemented from vtkDataSetAlgorithm.

virtual void vtkImplicitTextureCoords::SetRFunction ( vtkImplicitFunction )
virtual

Specify an implicit function to compute the r texture coordinate.

virtual vtkImplicitFunction* vtkImplicitTextureCoords::GetRFunction ( )
virtual

Specify an implicit function to compute the r texture coordinate.

virtual void vtkImplicitTextureCoords::SetSFunction ( vtkImplicitFunction )
virtual

Specify an implicit function to compute the s texture coordinate.

virtual vtkImplicitFunction* vtkImplicitTextureCoords::GetSFunction ( )
virtual

Specify an implicit function to compute the s texture coordinate.

virtual void vtkImplicitTextureCoords::SetTFunction ( vtkImplicitFunction )
virtual

Specify an implicit function to compute the t texture coordinate.

virtual vtkImplicitFunction* vtkImplicitTextureCoords::GetTFunction ( )
virtual

Specify an implicit function to compute the t texture coordinate.

virtual void vtkImplicitTextureCoords::SetFlipTexture ( int  )
virtual

If enabled, this will flip the sense of inside and outside the implicit function (i.e., a rotation around the r-s-t=0.5 axis).

virtual int vtkImplicitTextureCoords::GetFlipTexture ( )
virtual

If enabled, this will flip the sense of inside and outside the implicit function (i.e., a rotation around the r-s-t=0.5 axis).

virtual void vtkImplicitTextureCoords::FlipTextureOn ( )
virtual

If enabled, this will flip the sense of inside and outside the implicit function (i.e., a rotation around the r-s-t=0.5 axis).

virtual void vtkImplicitTextureCoords::FlipTextureOff ( )
virtual

If enabled, this will flip the sense of inside and outside the implicit function (i.e., a rotation around the r-s-t=0.5 axis).

int vtkImplicitTextureCoords::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.


Member Data Documentation

vtkImplicitFunction* vtkImplicitTextureCoords::RFunction
protected

Definition at line 100 of file vtkImplicitTextureCoords.h.

vtkImplicitFunction* vtkImplicitTextureCoords::SFunction
protected

Definition at line 101 of file vtkImplicitTextureCoords.h.

vtkImplicitFunction* vtkImplicitTextureCoords::TFunction
protected

Definition at line 102 of file vtkImplicitTextureCoords.h.

int vtkImplicitTextureCoords::FlipTexture
protected

Definition at line 103 of file vtkImplicitTextureCoords.h.


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