VTK
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

typedef vtkPointSet Superclass
 
enum  ControlPointType { MOVE_TO = 0, LINE_TO, CONIC_CURVE, CUBIC_CURVE }
 
- Public Types inherited from vtkPointSet
typedef vtkDataSet Superclass
 
- 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
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)
 
vtkPathNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetDataObjectType ()
 
void GetCellPoints (vtkIdType, vtkIdList *ptIds)
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
 
int GetMaxCellSize ()
 
void Allocate (vtkIdType size=1000, int extSize=1000)
 
void Reset ()
 
void InsertNextPoint (float pts[3], int code)
 
void InsertNextPoint (double pts[3], int code)
 
void InsertNextPoint (double x, double y, double z, int code)
 
void SetCodes (vtkIntArray *)
 
vtkIntArrayGetCodes ()
 
vtkIdType GetNumberOfCells ()
 
vtkCellGetCell (vtkIdType)
 
void GetCell (vtkIdType, vtkGenericCell *)
 
int GetCellType (vtkIdType)
 
- Public Member Functions inherited from vtkPointSet
vtkPointSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Initialize ()
 
void CopyStructure (vtkDataSet *pd)
 
vtkCellIteratorNewCellIterator ()
 
unsigned long GetMTime ()
 
void ComputeBounds ()
 
void Squeeze ()
 
unsigned long GetActualMemorySize ()
 
vtkIdType GetNumberOfPoints ()
 
doubleGetPoint (vtkIdType ptId)
 
void GetPoint (vtkIdType ptId, double x[3])
 
virtual vtkIdType FindPoint (double x[3])
 
vtkIdType FindPoint (double x, double y, double z)
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual void SetPoints (vtkPoints *)
 
virtual vtkPointsGetPoints ()
 
void ShallowCopy (vtkDataObject *src)
 
void DeepCopy (vtkDataObject *src)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
- Public Member Functions inherited from vtkDataSet
vtkDataSetNewInstance () const
 
virtual void CopyAttributes (vtkDataSet *ds)
 
virtual void GetCellBounds (vtkIdType cellId, double bounds[6])
 
virtual void GetCellTypes (vtkCellTypes *types)
 
vtkCellDataGetCellData ()
 
vtkPointDataGetPointData ()
 
doubleGetBounds ()
 
void GetBounds (double bounds[6])
 
doubleGetCenter ()
 
void GetCenter (double center[3])
 
double GetLength ()
 
virtual void GetScalarRange (double range[2])
 
doubleGetScalarRange ()
 
int CheckAttributes ()
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 
virtual vtkIdType GetNumberOfElements (int type)
 
bool HasAnyGhostCells ()
 
bool HasAnyGhostPoints ()
 
vtkUnsignedCharArrayGetPointGhostArray ()
 
void UpdatePointGhostArrayCache ()
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 
vtkUnsignedCharArrayGetCellGhostArray ()
 
void UpdateCellGhostArrayCache ()
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 
virtual void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 
vtkIdType FindPoint (double x, double y, double z)
 
virtual vtkCellFindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual void GenerateGhostArray (int zeroExt[6])
 
virtual void GenerateGhostArray (int zeroExt[6], bool cellOnly)
 
virtual bool HasAnyBlankCells ()
 
virtual bool HasAnyBlankPoints ()
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributesGetAttributes (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldDataGetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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)
 
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)
 
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 vtkPathNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPathSafeDownCast (vtkObjectBase *o)
 
static vtkPathGetData (vtkInformation *info)
 
static vtkPathGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkPointSet
static int IsTypeOf (const char *type)
 
static vtkPointSetSafeDownCast (vtkObjectBase *o)
 
static vtkPointSetGetData (vtkInformation *info)
 
static vtkPointSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static int IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
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 vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformationSetActiveAttribute (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 vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (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 vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPath ()
 
 ~vtkPath ()
 
- Protected Member Functions inherited from vtkPointSet
 vtkPointSet ()
 
 ~vtkPointSet ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet ()
 
virtual void ComputeScalarRange ()
 
bool IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)
 
- 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkPointSet
vtkPointsPoints
 
vtkPointLocatorLocator
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 
vtkUnsignedCharArrayCellGhostArray
 
bool PointGhostArrayCached
 
bool CellGhostArrayCached
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

concrete dataset representing a path defined by Bezier curves.

vtkPath provides a container for paths composed of line segment and 2nd/3rd order Bezier curves.

Tests:
vtkPath (Tests)

Definition at line 34 of file vtkPath.h.

Member Typedef Documentation

Definition at line 39 of file vtkPath.h.

Member Enumeration Documentation

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 57 of file vtkPath.h.

Constructor & Destructor Documentation

vtkPath::vtkPath ( )
protected
vtkPath::~vtkPath ( )
protected

Member Function Documentation

static vtkPath* vtkPath::New ( )
static
static int vtkPath::IsTypeOf ( const char *  type)
static
virtual int vtkPath::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 vtkPointSet.

static vtkPath* vtkPath::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPath::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointSet.

vtkPath* vtkPath::NewInstance ( ) const
void vtkPath::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 vtkDataSet.

int vtkPath::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 43 of file vtkPath.h.

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

Insert the next control point in the path.

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

Insert the next control point in the path.

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

Insert the next control point in the path.

void vtkPath::SetCodes ( vtkIntArray )

Set/Get the array of control point codes:

vtkIntArray* vtkPath::GetCodes ( )

Set/Get the array of control point codes:

vtkIdType vtkPath::GetNumberOfCells ( )
inlinevirtual

vtkPath doesn't use cells. These methods return trivial values.

Implements vtkDataSet.

Definition at line 81 of file vtkPath.h.

vtkCell* vtkPath::GetCell ( vtkIdType  )
inlinevirtual

vtkPath doesn't use cells. These methods return trivial values.

Implements vtkDataSet.

Definition at line 82 of file vtkPath.h.

void vtkPath::GetCell ( vtkIdType  ,
vtkGenericCell  
)
virtual

vtkPath doesn't use cells. These methods return trivial values.

Implements vtkDataSet.

int vtkPath::GetCellType ( vtkIdType  )
inlinevirtual

vtkPath doesn't use cells. These methods return trivial values.

Implements vtkDataSet.

Definition at line 84 of file vtkPath.h.

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

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

Implements vtkDataSet.

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

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

Implements vtkDataSet.

int vtkPath::GetMaxCellSize ( )
inlinevirtual

Return the maximum cell size in this poly data.

Implements vtkDataSet.

Definition at line 94 of file vtkPath.h.

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

Method allocates initial storage for points. Use this method before the method vtkPath::InsertNextPoint().

void vtkPath::Reset ( )

Begin inserting data all over again. Memory is not freed but otherwise objects are returned to their initial state.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.


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