A GPU resident data set. More...

#include <vtkPistonDataObject.h>

Inheritance diagram for vtkPistonDataObject:

Collaboration diagram for vtkPistonDataObject:

Public Types
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
typedef vtkObject	Superclass

enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPistonDataObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetDataObjectType ()

int	GetReferredType ()

void *	GetReferredData ()

virtual void	ComputeBounds ()

void	SetScalarsRange (double range[2])


vtkPistonReference *	GetReference ()


virtual void	ShallowCopy (vtkDataObject *src)

virtual void	DeepCopy (vtkDataObject *src)


double *	GetBounds ()

void	GetBounds (double bounds[6])

void	SetBounds (const double bounds[6])


double *	GetOrigin ()

void	GetOrigin (double origin[3])

void	SetOrigin (const double origin[3])


double *	GetSpacing ()

void	GetSpacing (double spacing[3])

void	SetSpacing (double spacing[3])


virtual char *	GetScalarsArrayName ()

virtual void	SetScalarsArrayName (const char *)


double *	GetScalarsRange ()

void	GetScalarsRange (double range[2])

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long int	GetMTime ()

virtual void	Initialize ()

void	ReleaseData ()

unsigned long	GetUpdateTime ()

virtual unsigned long	GetActualMemorySize ()

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))

void	DataHasBeenGenerated ()

virtual void	PrepareForNewData ()

virtual int	GetExtentType ()

virtual void	Crop (const int *updateExtent)

virtual vtkDataSetAttributes *	GetAttributes (int type)

virtual vtkFieldData *	GetAttributesAsFieldData (int type)

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)

virtual vtkIdType	GetNumberOfElements (int type)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual int	GetDataReleased ()

virtual void	SetFieldData (vtkFieldData *)

virtual vtkFieldData *	GetFieldData ()

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))

void	GlobalReleaseDataFlagOn ()

void	GlobalReleaseDataFlagOff ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkPistonDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkPistonDataObject *	SafeDownCast (vtkObjectBase *o)


static vtkPistonDataObject *	GetData (vtkInformation *info)

static vtkPistonDataObject *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static const char *	GetAssociationTypeAsString (int associationType)

static int	GetAssociationTypeFromString (const char *associationType)

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)

static vtkDataObject *	GetData (vtkInformation *info)

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)

static void	SetGlobalReleaseDataFlag (int val)

static int	GetGlobalReleaseDataFlag ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPistonDataObject ()

	~vtkPistonDataObject ()

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject ()

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 &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPistonReference *	Reference

bool	OwnReference

double	Bounds [6]

double	Origin [3]

double	Spacing [3]

char *	ScalarsArrayName

double	ScalarsRange [2]

vtkTimeStamp	ComputeTime

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A GPU resident data set.

vtkPistonDataObject is a basic data structure for storing datasets on GPU. This class provides the infrastructure for the VTK pipeline to work with the data as it does the rest of the vtkDataObjects. The GPU side structures are managed through the internal vtkPistonReference instance to keep the GPU/CPU code conceptually distinct.

See also: vtkPistonReference

Definition at line 41 of file vtkPistonDataObject.h.

Member Typedef Documentation

typedef vtkDataObject vtkPistonDataObject::Superclass

Definition at line 45 of file vtkPistonDataObject.h.

Constructor & Destructor Documentation

vtkPistonDataObject::vtkPistonDataObject ( )

protected

vtkPistonDataObject::~vtkPistonDataObject ( )

protected

Member Function Documentation

static vtkPistonDataObject* vtkPistonDataObject::New ( )

static

static int vtkPistonDataObject::IsTypeOf ( const char * type )

static

virtual int vtkPistonDataObject::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 vtkDataObject.

static vtkPistonDataObject* vtkPistonDataObject::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPistonDataObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

vtkPistonDataObject* vtkPistonDataObject::NewInstance ( ) const

void vtkPistonDataObject::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 vtkObject.

int vtkPistonDataObject::GetDataObjectType ( )

inlinevirtual

From vtkType.h, a handle on what type of vtkDataObject this is.

Reimplemented from vtkDataObject.

Definition at line 49 of file vtkPistonDataObject.h.

int vtkPistonDataObject::GetReferredType ( )

A convenience handle to get type of what is stored in the reference.

void* vtkPistonDataObject::GetReferredData ( )

A convenience handle to get whatever is actually stored in the reference.

vtkPistonReference* vtkPistonDataObject::GetReference ( )

inline

GPU level representation and storage this manages.

Definition at line 61 of file vtkPistonDataObject.h.

virtual void vtkPistonDataObject::ShallowCopy ( vtkDataObject * src )

virtual

Shallow/deep copy the data from src into this object.

Reimplemented from vtkDataObject.

virtual void vtkPistonDataObject::DeepCopy ( vtkDataObject * src )

virtual

Shallow/deep copy the data from src into this object.

Reimplemented from vtkDataObject.

virtual void vtkPistonDataObject::ComputeBounds ( )

virtual

Compute the data bounding box.

double* vtkPistonDataObject::GetBounds ( )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

void vtkPistonDataObject::GetBounds ( double bounds[6] )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

void vtkPistonDataObject::SetBounds ( const double bounds[6] )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

double* vtkPistonDataObject::GetOrigin ( )

void vtkPistonDataObject::GetOrigin ( double origin[3] )

void vtkPistonDataObject::SetOrigin ( const double origin[3] )

double* vtkPistonDataObject::GetSpacing ( )

void vtkPistonDataObject::GetSpacing ( double spacing[3] )

void vtkPistonDataObject::SetSpacing ( double spacing[3] )

virtual char* vtkPistonDataObject::GetScalarsArrayName ( )

virtual

Get scalars array name

virtual void vtkPistonDataObject::SetScalarsArrayName ( const char * )

virtual

Get scalars array name

double* vtkPistonDataObject::GetScalarsRange ( )

Get scalars range : For now only one scalar is supported in Piston

void vtkPistonDataObject::GetScalarsRange ( double range[2] )

Get scalars range : For now only one scalar is supported in Piston

void vtkPistonDataObject::SetScalarsRange ( double range[2] )

Set scalars range.

static vtkPistonDataObject* vtkPistonDataObject::GetData ( vtkInformation * info )

static

Retrieve an instance of this class from an information object.

static vtkPistonDataObject* vtkPistonDataObject::GetData	(	vtkInformationVector *	v,
		int	i = `0`
	)

static

Retrieve an instance of this class from an information object.

Member Data Documentation

vtkPistonReference* vtkPistonDataObject::Reference

protected

Definition at line 121 of file vtkPistonDataObject.h.

bool vtkPistonDataObject::OwnReference

protected

Definition at line 122 of file vtkPistonDataObject.h.

double vtkPistonDataObject::Bounds[6]

protected

Definition at line 123 of file vtkPistonDataObject.h.

double vtkPistonDataObject::Origin[3]

protected

Definition at line 124 of file vtkPistonDataObject.h.

double vtkPistonDataObject::Spacing[3]

protected

Definition at line 125 of file vtkPistonDataObject.h.

char* vtkPistonDataObject::ScalarsArrayName

protected

Definition at line 127 of file vtkPistonDataObject.h.

double vtkPistonDataObject::ScalarsRange[2]

protected

Definition at line 128 of file vtkPistonDataObject.h.

vtkTimeStamp vtkPistonDataObject::ComputeTime

protected

Definition at line 129 of file vtkPistonDataObject.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Accelerators/Piston/vtkPistonDataObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation