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

abstract class specifies interface to map 3D data More...

#include <vtkAbstractMapper3D.h>

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

List of all members.

Public Types

typedef vtkAbstractMapper Superclass
- Public Types inherited from vtkAbstractMapper
- 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 double * GetBounds ()=0
virtual void GetBounds (double bounds[6])
double GetLength ()
virtual int IsARayCastMapper ()
virtual int IsARenderIntoImageMapper ()
double * GetCenter ()
void GetCenter (double center[3])
- Public Member Functions inherited from vtkAbstractMapper
virtual unsigned long GetMTime ()
virtual void ReleaseGraphicsResources (vtkWindow *)
void SetClippingPlanes (vtkPlanes *planes)
void ShallowCopy (vtkAbstractMapper *m)
virtual double GetTimeToDraw ()
void AddClippingPlane (vtkPlane *plane)
void RemoveClippingPlane (vtkPlane *plane)
void RemoveAllClippingPlanes ()
virtual void SetClippingPlanes (vtkPlaneCollection *)
virtual vtkPlaneCollectionGetClippingPlanes ()
- 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 ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
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 ()
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 vtkAbstractMapper3DSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkAbstractMapper
static vtkDataArrayGetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKeyINPUT_PORT ()
static vtkInformationIntegerKeyINPUT_CONNECTION ()
static vtkInformationIntegerKeyPRESERVES_DATASET ()
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
static vtkInformationIntegerKeyPRESERVES_RANGES ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkAbstractMapper3D ()
 ~vtkAbstractMapper3D ()
- Protected Member Functions inherited from vtkAbstractMapper
 vtkAbstractMapper ()
 ~vtkAbstractMapper ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
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

double Bounds [6]
double Center [3]
- Protected Attributes inherited from vtkAbstractMapper
vtkTimerLogTimer
double TimeToDraw
vtkWindowLastWindow
vtkPlaneCollectionClippingPlanes
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

abstract class specifies interface to map 3D data

vtkAbstractMapper3D is an abstract class to specify interface between 3D data and graphics primitives or software rendering techniques. Subclasses of vtkAbstractMapper3D can be used for rendering geometry or rendering volumetric data.

This class also defines an API to support hardware clipping planes (at most six planes can be defined). It also provides geometric data about the input data it maps, such as the bounding box and center.

See also:
vtkAbstractMapper vtkMapper vtkPolyDataMapper vtkVolumeMapper

Definition at line 39 of file vtkAbstractMapper3D.h.


Member Typedef Documentation


Constructor & Destructor Documentation

vtkAbstractMapper3D::vtkAbstractMapper3D ( )
protected
vtkAbstractMapper3D::~vtkAbstractMapper3D ( )
inlineprotected

Definition at line 77 of file vtkAbstractMapper3D.h.


Member Function Documentation

virtual const char* vtkAbstractMapper3D::GetClassName ( )
virtual
static int vtkAbstractMapper3D::IsTypeOf ( const char *  name)
static
virtual int vtkAbstractMapper3D::IsA ( const char *  name)
virtual
static vtkAbstractMapper3D* vtkAbstractMapper3D::SafeDownCast ( vtkObject o)
static
void vtkAbstractMapper3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
virtual double* vtkAbstractMapper3D::GetBounds ( )
pure virtual

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). Update this->Bounds as a side effect.

Implemented in vtkMapper, vtkGraphMapper, vtkGlyph3DMapper, vtkPolyDataMapper, vtkCompositePolyDataMapper, and vtkAbstractVolumeMapper.

virtual void vtkAbstractMapper3D::GetBounds ( double  bounds[6])
virtual

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Reimplemented in vtkMapper, vtkGlyph3DMapper, vtkPolyDataMapper, vtkCompositePolyDataMapper, and vtkAbstractVolumeMapper.

double* vtkAbstractMapper3D::GetCenter ( )

Return the Center of this mapper's data.

void vtkAbstractMapper3D::GetCenter ( double  center[3])
inline

Return the Center of this mapper's data.

Definition at line 56 of file vtkAbstractMapper3D.h.

double vtkAbstractMapper3D::GetLength ( )

Return the diagonal length of this mappers bounding box.

virtual int vtkAbstractMapper3D::IsARayCastMapper ( )
inlinevirtual

Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper.

Definition at line 68 of file vtkAbstractMapper3D.h.

virtual int vtkAbstractMapper3D::IsARenderIntoImageMapper ( )
inlinevirtual

Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer.

Definition at line 73 of file vtkAbstractMapper3D.h.


Member Data Documentation

double vtkAbstractMapper3D::Bounds[6]
protected

Definition at line 77 of file vtkAbstractMapper3D.h.

double vtkAbstractMapper3D::Center[3]
protected

Definition at line 80 of file vtkAbstractMapper3D.h.


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