vtkPistonDataObject Class Reference

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
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 }
	Possible values for the FIELD_ASSOCIATION information entry. More...
enum	AttributeTypes {   POINT, CELL, FIELD, POINT_THEN_CELL,   VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...
enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkPistonDataObject *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
int	GetDataObjectType ()
	From vtkType.h, a handle on what type of vtkDataObject this is. More...
int	GetReferredType ()
	A convenience handle to get type of what is stored in the reference. More...
void *	GetReferredData ()
	A convenience handle to get whatever is actually stored in the reference. More...
vtkPistonReference *	GetReference ()
	GPU level representation and storage this manages. More...
virtual void	ShallowCopy (vtkDataObject *src)
	Shallow/deep copy the data from src into this object. More...
virtual void	DeepCopy (vtkDataObject *src)
virtual void	ComputeBounds ()
	Compute the data bounding box. More...
double *	GetBounds ()
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
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 ()
	Get scalars array name. More...
virtual void	SetScalarsArrayName (const char *)
double *	GetScalarsRange ()
	Get scalars range \NOTE: For now only one scalar is supported in Piston. More...
void	GetScalarsRange (double range[2])
void	SetScalarsRange (double range[2])
	Set scalars range. More...
Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...
virtual void	SetInformation (vtkInformation *)
vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime. More...
virtual void	Initialize ()
	Restore data object to initial state,. More...
void	ReleaseData ()
	Release data back to system to conserve memory resource. More...
virtual int	GetDataReleased ()
	Get the flag indicating the data has been released. More...
void	GlobalReleaseDataFlagOn ()
void	GlobalReleaseDataFlagOff ()
virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...
virtual vtkFieldData *	GetFieldData ()
vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes). More...
virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information. More...
virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information. More...
void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data. More...
virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted. More...
virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...
virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent. More...
virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type. More...
virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData. More...
virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from. More...
virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
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
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkPistonDataObject *	New ()
static int	IsTypeOf (const char *type)
static vtkPistonDataObject *	SafeDownCast (vtkObjectBase *o)
static vtkPistonDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...
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 void	SetGlobalReleaseDataFlag (int val)
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...
static int	GetGlobalReleaseDataFlag ()
static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...
static vtkInformation *	GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...
static void	RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
	Remove the info associated with an array. More...
static vtkInformation *	SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
static void	SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters. More...
static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...
static int	GetAssociationTypeFromString (const char *associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...
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 vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...
static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPistonDataObject ()
	~vtkPistonDataObject ()
Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()
	~vtkDataObject () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...
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 42 of file vtkPistonDataObject.h.

Member Typedef Documentation

Superclass

typedef vtkDataObject vtkPistonDataObject::Superclass

Definition at line 46 of file vtkPistonDataObject.h.

Constructor & Destructor Documentation

vtkPistonDataObject()

vtkPistonDataObject::vtkPistonDataObject ( )

protected

~vtkPistonDataObject()

vtkPistonDataObject::~vtkPistonDataObject ( )

protected

Member Function Documentation

New()

static vtkPistonDataObject* vtkPistonDataObject::New ( )

static

IsTypeOf()

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

static

IsA()

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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase* vtkPistonDataObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

NewInstance()

vtkPistonDataObject* vtkPistonDataObject::NewInstance

(

)

const

PrintSelf()

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 vtkObjectBase.

GetDataObjectType()

int vtkPistonDataObject::GetDataObjectType ( )

inlinevirtual

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

Reimplemented from vtkDataObject.

Definition at line 52 of file vtkPistonDataObject.h.

GetReferredType()

int vtkPistonDataObject::GetReferredType

(

)

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

GetReferredData()

void* vtkPistonDataObject::GetReferredData

(

)

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

GetReference()

vtkPistonReference* vtkPistonDataObject::GetReference ( )

inline

GPU level representation and storage this manages.

Definition at line 67 of file vtkPistonDataObject.h.

ShallowCopy()

virtual void vtkPistonDataObject::ShallowCopy ( vtkDataObject *  src )

virtual

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

Reimplemented from vtkDataObject.

DeepCopy()

virtual void vtkPistonDataObject::DeepCopy ( vtkDataObject *  src )

virtual

Reimplemented from vtkDataObject.

ComputeBounds()

virtual void vtkPistonDataObject::ComputeBounds ( )

virtual

Compute the data bounding box.

GetBounds() [1/2]

double* vtkPistonDataObject::GetBounds

(

)

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

GetBounds() [2/2]

void vtkPistonDataObject::GetBounds

(

double

bounds[6]

)

SetBounds()

void vtkPistonDataObject::SetBounds

(

const double

bounds[6]

)

GetOrigin() [1/2]

double* vtkPistonDataObject::GetOrigin

(

)

GetOrigin() [2/2]

void vtkPistonDataObject::GetOrigin

(

double

origin[3]

)

SetOrigin()

void vtkPistonDataObject::SetOrigin

(

const double

origin[3]

)

GetSpacing() [1/2]

double* vtkPistonDataObject::GetSpacing

(

)

GetSpacing() [2/2]

void vtkPistonDataObject::GetSpacing

(

double

spacing[3]

)

SetSpacing()

void vtkPistonDataObject::SetSpacing

(

double

spacing[3]

)

GetScalarsArrayName()

virtual char* vtkPistonDataObject::GetScalarsArrayName ( )

virtual

Get scalars array name.

SetScalarsArrayName()

virtual void vtkPistonDataObject::SetScalarsArrayName ( const char *  )

virtual

GetScalarsRange() [1/2]

double* vtkPistonDataObject::GetScalarsRange

(

)

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

GetScalarsRange() [2/2]

void vtkPistonDataObject::GetScalarsRange

(

double

range[2]

)

SetScalarsRange()

void vtkPistonDataObject::SetScalarsRange

(

double

range[2]

)

Set scalars range.

GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

GetData() [2/2]

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

static

Member Data Documentation

Reference

vtkPistonReference* vtkPistonDataObject::Reference

protected

Definition at line 138 of file vtkPistonDataObject.h.

OwnReference

bool vtkPistonDataObject::OwnReference

protected

Definition at line 139 of file vtkPistonDataObject.h.

Bounds

double vtkPistonDataObject::Bounds[6]

protected

Definition at line 140 of file vtkPistonDataObject.h.

Origin

double vtkPistonDataObject::Origin[3]

protected

Definition at line 141 of file vtkPistonDataObject.h.

Spacing

double vtkPistonDataObject::Spacing[3]

protected

Definition at line 142 of file vtkPistonDataObject.h.

ScalarsArrayName

char* vtkPistonDataObject::ScalarsArrayName

protected

Definition at line 144 of file vtkPistonDataObject.h.

ScalarsRange

double vtkPistonDataObject::ScalarsRange[2]

protected

Definition at line 145 of file vtkPistonDataObject.h.

ComputeTime

vtkTimeStamp vtkPistonDataObject::ComputeTime

protected

Definition at line 146 of file vtkPistonDataObject.h.

---

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

• dox/Accelerators/Piston/vtkPistonDataObject.h