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

cell represents a set of 0D vertices More...

#include <vtkPolyVertex.h>

Inheritance diagram for vtkPolyVertex:
[legend]
Collaboration diagram for vtkPolyVertex:
[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)
 
vtkPolyVertexNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetCellType ()
 
int GetCellDimension ()
 
int GetNumberOfEdges ()
 
int GetNumberOfFaces ()
 
vtkCellGetEdge (int vtkNotUsed(edgeId))
 
vtkCellGetFace (int vtkNotUsed(faceId))
 
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
 
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
 
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, 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)
 
int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
 
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
 
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)
 
int IsPrimaryCell ()
 
int GetParametricCenter (double pcoords[3])
 
- Public Member Functions inherited from vtkCell
vtkCellNewInstance () const
 
void Initialize (int npts, vtkIdType *pts, vtkPoints *p)
 
virtual void ShallowCopy (vtkCell *c)
 
virtual void DeepCopy (vtkCell *c)
 
virtual int IsLinear ()
 
virtual int RequiresInitialization ()
 
virtual void Initialize ()
 
virtual int IsExplicitCell ()
 
virtual int RequiresExplicitFaceRepresentation ()
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 
vtkIdType GetNumberOfPoints ()
 
vtkIdListGetPointIds ()
 
vtkIdType GetPointId (int ptId)
 
virtual vtkCellGetEdge (int edgeId)=0
 
virtual vtkCellGetFace (int faceId)=0
 
void GetBounds (double bounds[6])
 
doubleGetBounds ()
 
double GetLength2 ()
 
virtual double GetParametricDistance (double pcoords[3])
 
virtual doubleGetParametricCoords ()
 
virtual void InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
 
virtual void InterpolateDerivs (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool 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)
 
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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPolyVertexNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyVertexSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCell
static int IsTypeOf (const char *type)
 
static vtkCellSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkPolyVertex ()
 
 ~vtkPolyVertex ()
 
- 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 &)
 

Protected Attributes

vtkVertexVertex
 
- Protected Attributes inherited from vtkCell
double Bounds [6]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkCell
vtkPointsPoints
 
vtkIdListPointIds
 

Detailed Description

cell represents a set of 0D vertices

vtkPolyVertex is a concrete implementation of vtkCell to represent a set of 3D vertices.

Examples:
vtkPolyVertex (Examples)
Tests:
vtkPolyVertex (Tests)

Definition at line 37 of file vtkPolyVertex.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPolyVertex.h.

Constructor & Destructor Documentation

◆ vtkPolyVertex()

vtkPolyVertex::vtkPolyVertex ( )
protected

◆ ~vtkPolyVertex()

vtkPolyVertex::~vtkPolyVertex ( )
protected

Member Function Documentation

◆ New()

static vtkPolyVertex* vtkPolyVertex::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPolyVertex::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCell.

◆ NewInstance()

vtkPolyVertex* vtkPolyVertex::NewInstance ( ) const

◆ PrintSelf()

void vtkPolyVertex::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.

◆ GetCellType()

int vtkPolyVertex::GetCellType ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 46 of file vtkPolyVertex.h.

◆ GetCellDimension()

int vtkPolyVertex::GetCellDimension ( )
inlinevirtual

Return the topological dimensional of the cell (0,1,2, or 3).

Implements vtkCell.

Definition at line 47 of file vtkPolyVertex.h.

◆ GetNumberOfEdges()

int vtkPolyVertex::GetNumberOfEdges ( )
inlinevirtual

Return the number of edges in the cell.

Implements vtkCell.

Definition at line 48 of file vtkPolyVertex.h.

◆ GetNumberOfFaces()

int vtkPolyVertex::GetNumberOfFaces ( )
inlinevirtual

Return the number of faces in the cell.

Implements vtkCell.

Definition at line 49 of file vtkPolyVertex.h.

◆ GetEdge()

vtkCell* vtkPolyVertex::GetEdge ( int   vtkNotUsededgeId)
inline

Definition at line 50 of file vtkPolyVertex.h.

◆ GetFace()

vtkCell* vtkPolyVertex::GetFace ( int   vtkNotUsedfaceId)
inline

Definition at line 51 of file vtkPolyVertex.h.

◆ CellBoundary()

int vtkPolyVertex::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 face (3D cell), edge (2D cell), or vertex (1D cell). If the return value of the method is != 0, then the point is inside the cell.

Implements vtkCell.

◆ Contour()

void vtkPolyVertex::Contour ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray verts,
vtkCellArray lines,
vtkCellArray polys,
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). Contouring primitives can be vertices, lines, or polygons. It is possible to interpolate point data along the edge by providing input and output point data - if outPd is NULL, then no interpolation is performed. Also, if the output cell data is non-NULL, the cell data from the contoured cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)

Implements vtkCell.

◆ Clip()

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

Cut (or clip) the cell based on the input cellScalars and the specified value. The output of the clip operation will be one or more cells of the same topological dimension as the original cell. The flag insideOut controls what part of the cell is considered inside - normally cell points whose scalar value is greater than "value" are considered inside. If insideOut is on, this is reversed. Also, if the output cell data is non-NULL, the cell data from the clipped cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)

Implements vtkCell.

◆ EvaluatePosition()

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

Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3] (unless closestPoint is null, in which case, the closest point and dist2 are not found), and interpolation weights in cell. (The number of weights is equal to the number of points defining the cell). Note: on rare occasions a -1 is returned from the method. This means that numerical error has occurred and all data returned from this method should be ignored. Also, inside/outside is determine parametrically. That is, a point is inside if it satisfies parametric limits. This can cause problems for cells of topological dimension 2 or less, since a point in 3D can project onto the cell within parametric limits but be "far" from the cell. Thus the value dist2 may be checked to determine true in/out.

Implements vtkCell.

◆ EvaluateLocation()

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

Determine global coordinate (x[3]) from subId and parametric coordinates. Also returns interpolation weights. (The number of weights is equal to the number of points in the cell.)

Implements vtkCell.

◆ IntersectWithLine()

int vtkPolyVertex::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 p1[3], p2[3] and tolerance tol. The method returns non-zero value if intersection occurs. A parametric distance t between 0 and 1 along the ray representing the intersection point, the point coordinates x[3] in data coordinates and also pcoords[3] in parametric coordinates. subId is the index within the cell if a composed cell like a triangle strip.

Implements vtkCell.

◆ Triangulate()

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

Generate simplices of proper dimension. If cell is 3D, tetrahedron are generated; if 2D triangles; if 1D lines; if 0D points. The form of the output is a sequence of points, each n+1 points (where n is topological cell dimension) defining a simplex. The index is a parameter that controls which triangulation to use (if more than one is possible). If numerical degeneracy encountered, 0 is returned, otherwise 1 is returned. This method does not insert new points: all the points that define the simplices are the points that define the cell.

Implements vtkCell.

◆ Derivatives()

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

Compute derivatives given cell subId and parametric coordinates. The values array is a series of data value(s) at the cell points. There is a one-to-one correspondence between cell point and data value(s). Dim is the number of data values per cell point. Derivs are derivatives in the x-y-z coordinate directions for each data value. Thus, if computing derivatives for a scalar function in a hexahedron, dim=1, 8 values are supplied, and 3 deriv values are returned (i.e., derivatives in x-y-z directions). On the other hand, if computing derivatives of velocity (vx,vy,vz) dim=3, 24 values are supplied ((vx,vy,vz)1, (vx,vy,vz)2, ....()8), and 9 deriv values are returned ((d(vx)/dx),(d(vx)/dy),(d(vx)/dz), (d(vy)/dx),(d(vy)/dy), (d(vy)/dz), (d(vz)/dx),(d(vz)/dy),(d(vz)/dz)).

Implements vtkCell.

◆ IsPrimaryCell()

int vtkPolyVertex::IsPrimaryCell ( )
inlinevirtual

Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet). This compares to composite cells that are typically composed of primary cells (e.g., a triangle strip composite cell is made up of triangle primary cells).

Reimplemented from vtkCell.

Definition at line 73 of file vtkPolyVertex.h.

◆ GetParametricCenter()

int vtkPolyVertex::GetParametricCenter ( double  pcoords[3])
virtual

Return the center of the point cloud in parametric coordinates.

Reimplemented from vtkCell.

Member Data Documentation

◆ Vertex

vtkVertex* vtkPolyVertex::Vertex
protected

Definition at line 83 of file vtkPolyVertex.h.


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