VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPath Class Reference

concrete dataset representing a path defined by Bezier curves. More...

#include <vtkPath.h>

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

Public Types

enum  ControlPointType { MOVE_TO = 0 , LINE_TO , CONIC_CURVE , CUBIC_CURVE }
 Enumeration of recognized control point types: More...
 
typedef vtkPointSet Superclass
 
- Public Types inherited from vtkPointSet
typedef vtkDataSet Superclass
 Standard methdos for type information and printing.
 
- Public Types inherited from vtkDataSet
enum  FieldDataType { DATA_OBJECT_FIELD = 0 , POINT_DATA_FIELD = 1 , CELL_DATA_FIELD = 2 }
 
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 vtkTypeBool IsA (const char *type)
 Standard methdos for type information and printing.
 
vtkPathNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int GetDataObjectType () override
 Return what type of dataset this is.
 
vtkIdType GetNumberOfCells () override
 vtkPath doesn't use cells.
 
vtkCellGetCell (vtkIdType) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
void GetCell (vtkIdType, vtkGenericCell *) override
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
int GetCellType (vtkIdType) override
 Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
 
void GetCellPoints (vtkIdType, vtkIdList *ptIds) override
 vtkPath doesn't use cells, this method just clears ptIds.
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 vtkPath doesn't use cells, this method just clears cellIds.
 
int GetMaxCellSize () override
 Return the maximum cell size in this poly data.
 
void Allocate (vtkIdType size=1000, int extSize=1000)
 Method allocates initial storage for points.
 
void Reset ()
 Begin inserting data all over again.
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
void InsertNextPoint (float pts[3], int code)
 Insert the next control point in the path.
 
void InsertNextPoint (double pts[3], int code)
 Insert the next control point in the path.
 
void InsertNextPoint (double x, double y, double z, int code)
 Insert the next control point in the path.
 
void SetCodes (vtkIntArray *)
 Set/Get the array of control point codes:
 
vtkIntArrayGetCodes ()
 Set/Get the array of control point codes:
 
- Public Member Functions inherited from vtkPointSet
void Initialize () override
 Reset to an empty state and free any memory.
 
void CopyStructure (vtkDataSet *pd) override
 Copy the geometric structure of an input point set object.
 
vtkCellGetCell (vtkIdType) override
 This method always return a vtkEmptyCell, as there is no cell in a vtkPointSet.
 
void GetCell (vtkIdType, vtkGenericCell *cell) override
 This method sets cell to be an empty cell.
 
int GetCellType (vtkIdType) override
 This method always returns VTK_EMPTY_CELL, as there is no cell in a vtkPointSet.
 
double * GetPoint (vtkIdType ptId) override
 See vtkDataSet for additional information.
 
vtkCellIteratorNewCellIterator () override
 Return an iterator that traverses the cells in this data set.
 
void BuildCellLocator ()
 Build the cell locator.
 
vtkMTimeType GetMTime () override
 Get MTime which also considers its vtkPoints MTime.
 
void ComputeBounds () override
 Compute the (X, Y, Z) bounds of the data.
 
void Squeeze () override
 Reclaim any unused memory.
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes).
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual void SetEditable (bool)
 Specify whether this dataset is editable after creation.
 
virtual bool GetEditable ()
 Specify whether this dataset is editable after creation.
 
virtual void EditableOn ()
 Specify whether this dataset is editable after creation.
 
virtual void EditableOff ()
 Specify whether this dataset is editable after creation.
 
vtkIdType GetNumberOfPoints () override
 See vtkDataSet for additional information.
 
void GetPoint (vtkIdType ptId, double x[3]) override
 See vtkDataSet for additional information.
 
vtkIdType FindPoint (double x[3]) override
 See vtkDataSet for additional information.
 
vtkIdType FindPoint (double x, double y, double z)
 See vtkDataSet for additional information.
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 See vtkDataSet for additional information.
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 See vtkDataSet for additional information.
 
vtkIdType GetNumberOfCells () override
 This method always returns 0, as there are no cells in a vtkPointSet.
 
int GetMaxCellSize () override
 This method always returns 0, as there are no cells in a vtkPointSet.
 
void GetCellPoints (vtkIdType, vtkIdList *idList) override
 This method resets parameter idList, as there is no cell in a vtkPointSet.
 
void GetPointCells (vtkIdType, vtkIdList *idList) override
 This method resets parameter idList, as there is no cell in a vtkPointSet.
 
void BuildPointLocator ()
 Build the internal point locator .
 
void BuildLocator ()
 Build the internal point locator .
 
virtual void SetPointLocator (vtkAbstractPointLocator *)
 Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.
 
virtual vtkAbstractPointLocatorGetPointLocator ()
 Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods.
 
virtual void SetCellLocator (vtkAbstractCellLocator *)
 Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation.
 
virtual vtkAbstractCellLocatorGetCellLocator ()
 Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation.
 
virtual void SetPoints (vtkPoints *)
 Specify point array to define point coordinates.
 
virtual vtkPointsGetPoints ()
 Specify point array to define point coordinates.
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
void Register (vtkObjectBase *o) override
 Overwritten to handle the data/locator loop.
 
void UnRegister (vtkObjectBase *o) override
 Overwritten to handle the data/locator loop.
 
vtkPointSetNewInstance () const
 Standard methdos for type information and printing.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methdos for type information and printing.
 
- Public Member Functions inherited from vtkDataSet
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void CopyStructure (vtkDataSet *ds)=0
 Copy the geometric and topological structure of an object.
 
virtual void CopyAttributes (vtkDataSet *ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet.
 
virtual vtkIdType GetNumberOfPoints ()=0
 Determine the number of points composing the dataset.
 
virtual vtkIdType GetNumberOfCells ()=0
 Determine the number of cells composing the dataset.
 
virtual double * GetPoint (vtkIdType ptId)=0
 Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
 
virtual void GetPoint (vtkIdType id, double x[3])
 Copy point coordinates into user provided array x[3] for specified point id.
 
virtual vtkCellIteratorNewCellIterator ()
 Return an iterator that traverses the cells in this data set.
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkCellGetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k))
 
void SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell)
 
virtual void GetCell (vtkIdType cellId, vtkGenericCell *cell)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual int GetCellType (vtkIdType cellId)=0
 Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual void GetCellTypes (vtkCellTypes *types)
 Get a list of types of cells in a dataset.
 
virtual void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0
 Topological inquiry to get points defining cell.
 
virtual void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0
 Topological inquiry to get cells using point.
 
virtual void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId).
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 Locate cell based on global coordinate x and tolerance squared.
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 This is a version of the above method that can be used with multithreaded applications.
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 Locate the cell that contains a point and return the cell.
 
vtkMTimeType GetMTime () override
 Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data.
 
vtkPointDataGetPointData ()
 Return a pointer to this dataset's point data.
 
virtual void Squeeze ()
 Reclaim any extra memory used to store data.
 
virtual void ComputeBounds ()
 Compute the data bounding box from data points.
 
double * GetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
 
double * GetCenter ()
 Get the center of the bounding box.
 
void GetCenter (double center[3])
 Get the center of the bounding box.
 
double GetLength ()
 Return the length of the diagonal of the bounding box.
 
void Initialize () override
 Restore data object to initial state.
 
virtual void GetScalarRange (double range[2])
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.
 
double * GetScalarRange ()
 Convenience method to get the range of the first component (and only the first component) of any scalars in the data set.
 
virtual int GetMaxCellSize ()=0
 Convenience method returns largest cell size in dataset.
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes).
 
int GetDataObjectType () override
 Return the type of data object.
 
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry.
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData.
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
bool HasAnyGhostCells ()
 Returns 1 if there are any ghost cells 0 otherwise.
 
bool HasAnyGhostPoints ()
 Returns 1 if there are any ghost points 0 otherwise.
 
virtual bool HasAnyBlankCells ()
 Returns 1 if there are any blanking cells 0 otherwise.
 
virtual bool HasAnyBlankPoints ()
 Returns 1 if there are any blanking points 0 otherwise.
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point.
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array.
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points.
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell.
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array.
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells.
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x.
 
virtual void GenerateGhostArray (int zeroExt[6])
 Normally called by pipeline executives or algorithms only.
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 Normally called by pipeline executives or algorithms only.
 
- Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Data objects are composite objects and need to check each part for MTime.
 
virtual void Initialize ()
 Restore data object to initial state,.
 
void ReleaseData ()
 Release data back to system to conserve memory resource.
 
virtual int GetDataObjectType ()
 Return class name of data type.
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
 
virtual unsigned long GetActualMemorySize ()
 Return the actual size of the data in kibibytes (1024 bytes).
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information.
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information.
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data.
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted.
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent.
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkDataArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified atribute type.
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData.
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from.
 
virtual vtkIdType GetNumberOfElements (int type)
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object.
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released.
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object.
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object.
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkPathNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPathSafeDownCast (vtkObjectBase *o)
 
static vtkPathGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkPathGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkPointSet
static vtkPointSetNew ()
 Standard instantiation method.
 
static vtkPointSetExtendedNew ()
 
static vtkPointSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkPointSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methdos for type information and printing.
 
static vtkPointSetSafeDownCast (vtkObjectBase *o)
 Standard methdos for type information and printing.
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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)
 
static vtkInformationGetNamedFieldInformation (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.
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array.
 
static vtkInformationSetActiveAttribute (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).
 
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).
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters.
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e.
 
static int GetAssociationTypeFromString (const char *associationName)
 Given a string association name, this static method returns an integer association type for the attribute (i.e.
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
static int GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 Standard methdos for type information and printing.
 
 vtkPath ()
 
 ~vtkPath () override
 
- Protected Member Functions inherited from vtkPointSet
 vtkPointSet ()
 
 ~vtkPointSet () override
 
void ReportReferences (vtkGarbageCollector *) override
 
- Protected Member Functions inherited from vtkDataSet
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSet ()
 
 ~vtkDataSet () override
 
virtual void ComputeScalarRange ()
 Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime).
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 Helper function that tests if any of the values in 'a' have bitFlag set.
 
- Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBaseNewInstanceInternal () const
 
 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=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkPointSet
bool Editable
 
vtkPointsPoints
 
vtkAbstractPointLocatorPointLocator
 
vtkAbstractCellLocatorCellLocator
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
vtkUnsignedCharArrayCellGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
bool PointGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
bool CellGhostArrayCached
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

concrete dataset representing a path defined by Bezier curves.

vtkPath provides a container for paths composed of line segments, 2nd-order (quadratic) and 3rd-order (cubic) Bezier curves.

Definition at line 32 of file vtkPath.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkPath.h.

Member Enumeration Documentation

◆ ControlPointType

Enumeration of recognized control point types:

  • MOVE_TO: Point defining the origin of a new segment, not connected to the previous point.
  • LINE_TO: Draw a line from the previous point to the current one
  • CONIC_CURVE: 2nd order (conic/quadratic) point. Must appear in sets of 2, e.g. (0,0) MOVE_TO (0,1) CONIC_CURVE (1,2) CONIC_CURVE defines a quadratic Bezier curve that passes through (0,0) and (1,2) using (0,1) as a control (off) point.
  • CUBIC_CURVE: 3rd order (cubic) control point. Must appear in sets of 3, e.g. (0,0) MOVE_TO (0,1) CUBIC_CURVE (1,2) CUBIC_CURVE (4,0) CUBIC_CURVE defines a cubic Bezier curve that passes through (0,0) and (4,0), using (0,1) and (1,2) as control (off) points.
Enumerator
MOVE_TO 
LINE_TO 
CONIC_CURVE 
CUBIC_CURVE 

Definition at line 59 of file vtkPath.h.

Constructor & Destructor Documentation

◆ vtkPath()

vtkPath::vtkPath ( )
protected

◆ ~vtkPath()

vtkPath::~vtkPath ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPath * vtkPath::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkPath::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkPath::IsA ( const char *  type)
virtual

Standard methdos for type information and printing.

Reimplemented from vtkPointSet.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPath::NewInstanceInternal ( ) const
protectedvirtual

Standard methdos for type information and printing.

Reimplemented from vtkPointSet.

◆ NewInstance()

vtkPath * vtkPath::NewInstance ( ) const

◆ PrintSelf()

void vtkPath::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ GetDataObjectType()

int vtkPath::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 43 of file vtkPath.h.

◆ InsertNextPoint() [1/3]

void vtkPath::InsertNextPoint ( float  pts[3],
int  code 
)

Insert the next control point in the path.

◆ InsertNextPoint() [2/3]

void vtkPath::InsertNextPoint ( double  pts[3],
int  code 
)

Insert the next control point in the path.

◆ InsertNextPoint() [3/3]

void vtkPath::InsertNextPoint ( double  x,
double  y,
double  z,
int  code 
)

Insert the next control point in the path.

◆ SetCodes()

void vtkPath::SetCodes ( vtkIntArray )

Set/Get the array of control point codes:

◆ GetCodes()

vtkIntArray * vtkPath::GetCodes ( )

Set/Get the array of control point codes:

◆ GetNumberOfCells()

vtkIdType vtkPath::GetNumberOfCells ( )
inlineoverridevirtual

vtkPath doesn't use cells.

These methods return trivial values.

Implements vtkDataSet.

Definition at line 87 of file vtkPath.h.

◆ GetCell() [1/5]

vtkCell * vtkPath::GetCell ( vtkIdType  cellId)
inlineoverridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.

Warning
Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.
THIS METHOD IS NOT THREAD SAFE. For a thread-safe version, please use void GetCell(vtkIdType cellId, vtkGenericCell* cell).

Implements vtkDataSet.

Definition at line 89 of file vtkPath.h.

◆ GetCell() [2/5]

void vtkPath::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

◆ GetCellType()

int vtkPath::GetCellType ( vtkIdType  cellId)
inlineoverridevirtual

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Implements vtkDataSet.

Definition at line 91 of file vtkPath.h.

◆ GetCellPoints()

void vtkPath::GetCellPoints ( vtkIdType  ,
vtkIdList ptIds 
)
overridevirtual

vtkPath doesn't use cells, this method just clears ptIds.

Implements vtkDataSet.

◆ GetPointCells()

void vtkPath::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
overridevirtual

vtkPath doesn't use cells, this method just clears cellIds.

Implements vtkDataSet.

◆ GetMaxCellSize()

int vtkPath::GetMaxCellSize ( )
inlineoverridevirtual

Return the maximum cell size in this poly data.

Implements vtkDataSet.

Definition at line 106 of file vtkPath.h.

◆ Allocate()

void vtkPath::Allocate ( vtkIdType  size = 1000,
int  extSize = 1000 
)

Method allocates initial storage for points.

Use this method before the method vtkPath::InsertNextPoint().

◆ Reset()

void vtkPath::Reset ( )

Begin inserting data all over again.

Memory is not freed but otherwise objects are returned to their initial state.

◆ GetData() [1/2]

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

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

Retrieve an instance of this class from an information object.

◆ GetCell() [3/5]

virtual vtkCell * vtkDataSet::GetCell ( vtkIdType  cellId)
virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.

Warning
Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.
THIS METHOD IS NOT THREAD SAFE. For a thread-safe version, please use void GetCell(vtkIdType cellId, vtkGenericCell* cell).

Reimplemented from vtkPointSet.

◆ GetCell() [4/5]

virtual vtkCell * vtkDataSet::GetCell ( int   vtkNotUsedi,
int   vtkNotUsedj,
int   vtkNotUsed
)
inlinevirtual

Reimplemented from vtkDataSet.

Definition at line 231 of file vtkDataSet.h.

◆ GetCell() [5/5]

virtual void vtkDataSet::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED

Reimplemented from vtkPointSet.


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