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

a cell that represents a 3D point More...

#include <vtkVertex.h>

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

Public Types

typedef vtkCell Superclass
 
- Public Types inherited from vtkCell
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkVertex * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
 
int GetParametricCenter (double pcoords[3])
 
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
 
int GetCellType ()
 
int GetCellDimension ()
 
int GetNumberOfEdges ()
 
int GetNumberOfFaces ()
 
vtkCell * GetEdge (int)
 
vtkCell * GetFace (int)
 
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *pts, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
 
int EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights)
 
void EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights)
 
virtual double * GetParametricCoords ()
 
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts1, vtkCellArray *lines, vtkCellArray *verts2, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
 
int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
 
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)
 
virtual void InterpolateFunctions (double pcoords[3], double weights[1])
 
virtual void InterpolateDerivs (double pcoords[3], double derivs[3])
 
- Public Member Functions inherited from vtkCell
vtkCell * NewInstance () const
 
void Initialize (int npts, vtkIdType *pts, vtkPoints *p)
 
virtual void ShallowCopy (vtkCell *c)
 
virtual void DeepCopy (vtkCell *c)
 
virtual int IsLinear ()
 
virtual int IsExplicitCell ()
 
vtkPoints * GetPoints ()
 
vtkIdType GetNumberOfPoints ()
 
vtkIdList * GetPointIds ()
 
vtkIdType GetPointId (int ptId)
 
void GetBounds (double bounds[6])
 
double * GetBounds ()
 
double GetLength2 ()
 
virtual double GetParametricDistance (double pcoords[3])
 
virtual int IsPrimaryCell ()
 
virtual int RequiresInitialization ()
 
virtual void Initialize ()
 
virtual int RequiresExplicitFaceRepresentation ()
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdType * GetFaces ()
 
virtual void InterpolateFunctions (double pcoords[3], double weights[3])
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
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 vtkVertex * New ()
 
static int IsTypeOf (const char *type)
 
static vtkVertex * SafeDownCast (vtkObjectBase *o)
 
static void InterpolationFunctions (double pcoords[3], double weights[1])
 
static void InterpolationDerivs (double pcoords[3], double derivs[3])
 
- Static Public Member Functions inherited from vtkCell
static int IsTypeOf (const char *type)
 
static vtkCell * SafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkVertex ()
 
 ~vtkVertex ()
 
- Protected Member Functions inherited from vtkCell
 vtkCell ()
 
 ~vtkCell ()
 
- 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 &)
 

Additional Inherited Members

- Public Attributes inherited from vtkCell
vtkPoints * Points
 
vtkIdList * PointIds
 
- Protected Attributes inherited from vtkCell
double Bounds [6]
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt< vtkTypeInt32 > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a cell that represents a 3D point

vtkVertex is a concrete implementation of vtkCell to represent a 3D point.

Examples:
vtkVertex (Examples)
Tests:
vtkVertex (Tests)

Definition at line 35 of file vtkVertex.h.

Member Typedef Documentation

Definition at line 39 of file vtkVertex.h.

Constructor & Destructor Documentation

vtkVertex::vtkVertex ( )
protected
vtkVertex::~vtkVertex ( )
inlineprotected

Definition at line 125 of file vtkVertex.h.

Member Function Documentation

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

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

Reimplemented from vtkCell.

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

int vtkVertex::GetCellType ( )
inlinevirtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 46 of file vtkVertex.h.

int vtkVertex::GetCellDimension ( )
inlinevirtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 47 of file vtkVertex.h.

int vtkVertex::GetNumberOfEdges ( )
inlinevirtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 48 of file vtkVertex.h.

int vtkVertex::GetNumberOfFaces ( )
inlinevirtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 49 of file vtkVertex.h.

vtkCell* vtkVertex::GetEdge ( int  )
inlinevirtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 50 of file vtkVertex.h.

vtkCell* vtkVertex::GetFace ( int  )
inlinevirtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 51 of file vtkVertex.h.

void vtkVertex::Clip ( double  value,
vtkDataArray *  cellScalars,
vtkIncrementalPointLocator *  locator,
vtkCellArray *  pts,
vtkPointData *  inPd,
vtkPointData *  outPd,
vtkCellData *  inCd,
vtkIdType  cellId,
vtkCellData *  outCd,
int  insideOut 
)
virtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkVertex::EvaluatePosition ( double  x[3],
double *  closestPoint,
int &  subId,
double  pcoords[3],
double &  dist2,
double *  weights 
)
virtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkVertex::EvaluateLocation ( int &  subId,
double  pcoords[3],
double  x[3],
double *  weights 
)
virtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

virtual double* vtkVertex::GetParametricCoords ( )
virtual

Make a new vtkVertex object with the same information as this object.

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

int vtkVertex::CellBoundary ( int  subId,
double  pcoords[3],
vtkIdList *  pts 
)
virtual

Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. The cell boundary is defined by a list of points (pts) that specify a vertex (1D cell). If the return value of the method is != 0, then the point is inside the cell.

Implements vtkCell.

void vtkVertex::Contour ( double  value,
vtkDataArray *  cellScalars,
vtkIncrementalPointLocator *  locator,
vtkCellArray *  verts1,
vtkCellArray *  lines,
vtkCellArray *  verts2,
vtkPointData *  inPd,
vtkPointData *  outPd,
vtkCellData *  inCd,
vtkIdType  cellId,
vtkCellData *  outCd 
)
virtual

Generate contouring primitives. The scalar list cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points as they are inserted (i.e., prevents duplicates).

Implements vtkCell.

int vtkVertex::GetParametricCenter ( double  pcoords[3])
inlinevirtual

Return the center of the triangle in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 133 of file vtkVertex.h.

int vtkVertex::IntersectWithLine ( double  p1[3],
double  p2[3],
double  tol,
double &  t,
double  x[3],
double  pcoords[3],
int &  subId 
)
virtual

Intersect with a ray. Return parametric coordinates (both line and cell) and global intersection coordinates, given ray definition and tolerance. The method returns non-zero value if intersection occurs.

Implements vtkCell.

int vtkVertex::Triangulate ( int  index,
vtkIdList *  ptIds,
vtkPoints *  pts 
)
virtual

Triangulate the vertex. This method fills pts and ptIds with information from the only point in the vertex.

Implements vtkCell.

void vtkVertex::Derivatives ( int  subId,
double  pcoords[3],
double *  values,
int  dim,
double *  derivs 
)
virtual

Get the derivative of the vertex. Returns (0.0, 0.0, 0.0) for all dimensions.

Implements vtkCell.

static void vtkVertex::InterpolationFunctions ( double  pcoords[3],
double  weights[1] 
)
static
Deprecated:
Replaced by vtkVertex::InterpolateFunctions as of VTK 5.2
static void vtkVertex::InterpolationDerivs ( double  pcoords[3],
double  derivs[3] 
)
static
Deprecated:
Replaced by vtkVertex::InterpolateDerivs as of VTK 5.2
virtual void vtkVertex::InterpolateFunctions ( double  pcoords[3],
double  weights[1] 
)
inlinevirtual

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Definition at line 113 of file vtkVertex.h.

virtual void vtkVertex::InterpolateDerivs ( double  pcoords[3],
double  derivs[3] 
)
inlinevirtual

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Reimplemented from vtkCell.

Definition at line 117 of file vtkVertex.h.


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