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

cell represents a 1D line More...

#include <vtkLine.h>

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

Public Types

typedef vtkCell Superclass
 
- Public Types inherited from vtkCell
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...
 
vtkLineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *lines, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
 Clip this line using scalar value provided. More...
 
int GetParametricCenter (double pcoords[3]) override
 Return the center of the triangle in parametric coordinates. More...
 
int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
 Line-line intersection. More...
 
int GetCellType () override
 See the vtkCell API for descriptions of these methods. More...
 
int GetCellDimension () override
 See the vtkCell API for descriptions of these methods. More...
 
int GetNumberOfEdges () override
 See the vtkCell API for descriptions of these methods. More...
 
int GetNumberOfFaces () override
 See the vtkCell API for descriptions of these methods. More...
 
vtkCellGetEdge (int) override
 See the vtkCell API for descriptions of these methods. More...
 
vtkCellGetFace (int) override
 See the vtkCell API for descriptions of these methods. More...
 
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts) override
 See the vtkCell API for descriptions of these methods. More...
 
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override
 See the vtkCell API for descriptions of these methods. More...
 
int EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights) override
 See the vtkCell API for descriptions of these methods. More...
 
void EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights) override
 See the vtkCell API for descriptions of these methods. More...
 
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts) override
 See the vtkCell API for descriptions of these methods. More...
 
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs) override
 See the vtkCell API for descriptions of these methods. More...
 
doubleGetParametricCoords () override
 See the vtkCell API for descriptions of these methods. More...
 
void InterpolateFunctions (double pcoords[3], double weights[2]) override
 Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...
 
void InterpolateDerivs (double pcoords[3], double derivs[2]) override
 Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...
 
- Public Member Functions inherited from vtkCell
vtkCellNewInstance () const
 
void Initialize (int npts, vtkIdType *pts, vtkPoints *p)
 Initialize cell from outside with point ids and point coordinates specified. More...
 
virtual void ShallowCopy (vtkCell *c)
 Copy this cell by reference counting the internal data structures. More...
 
virtual void DeepCopy (vtkCell *c)
 Copy this cell by completely copying internal data structures. More...
 
virtual int IsLinear ()
 Non-linear cells require special treatment beyond the usual cell type and connectivity list information. More...
 
virtual int RequiresInitialization ()
 Some cells require initialization prior to access. More...
 
virtual void Initialize ()
 
virtual int IsExplicitCell ()
 Explicit cells require additional representational information beyond the usual cell type and connectivity list information. More...
 
virtual int RequiresExplicitFaceRepresentation ()
 Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods). More...
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 Get the point coordinates for the cell. More...
 
vtkIdType GetNumberOfPoints ()
 Return the number of points in the cell. More...
 
vtkIdListGetPointIds ()
 Return the list of point ids defining the cell. More...
 
vtkIdType GetPointId (int ptId)
 For cell point i, return the actual point id. More...
 
void GetBounds (double bounds[6])
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...
 
doubleGetBounds ()
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...
 
double GetLength2 ()
 Compute Length squared of cell (i.e., bounding box diagonal squared). More...
 
virtual double GetParametricDistance (double pcoords[3])
 Return the distance of the parametric coordinate provided to the cell. More...
 
virtual int IsPrimaryCell ()
 Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet). More...
 
virtual void InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
 Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level. More...
 
virtual void InterpolateDerivs (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkLineNew ()
 
static int IsTypeOf (const char *type)
 
static vtkLineSafeDownCast (vtkObjectBase *o)
 
static int Intersection (double p1[3], double p2[3], double x1[3], double x2[3], double &u, double &v)
 Performs intersection of the projection of two finite 3D lines onto a 2D plane. More...
 
static int Intersection3D (double p1[3], double p2[3], double x1[3], double x2[3], double &u, double &v)
 Performs intersection of two finite 3D lines. More...
 
static double DistanceToLine (double x[3], double p1[3], double p2[3], double &t, double *closestPoint=NULL)
 Compute the distance of a point x to a finite line (p1,p2). More...
 
static double DistanceToLine (double x[3], double p1[3], double p2[3])
 Determine the distance of the current vertex to the edge defined by the vertices provided. More...
 
static double DistanceBetweenLines (double l0[3], double l1[3], double m0[3], double m1[3], double closestPt1[3], double closestPt2[3], double &t1, double &t2)
 Computes the shortest distance squared between two infinite lines, each defined by a pair of points (l0,l1) and (m0,m1). More...
 
static double DistanceBetweenLineSegments (double l0[3], double l1[3], double m0[3], double m1[3], double closestPt1[3], double closestPt2[3], double &t1, double &t2)
 Computes the shortest distance squared between two finite line segments defined by their end points (l0,l1) and (m0,m1). More...
 
static void InterpolationFunctions (double pcoords[3], double weights[2])
 
static void InterpolationDerivs (double pcoords[3], double derivs[2])
 
- 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 vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLine ()
 
 ~vtkLine () override
 
- Protected Member Functions inherited from vtkCell
 vtkCell ()
 
 ~vtkCell () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
vtkPointsPoints
 
vtkIdListPointIds
 
- 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
 

Detailed Description

cell represents a 1D line

vtkLine is a concrete implementation of vtkCell to represent a 1D line.

Examples:
vtkLine (Examples)
Tests:
vtkLine (Tests)

Definition at line 35 of file vtkLine.h.

Member Typedef Documentation

Definition at line 39 of file vtkLine.h.

Constructor & Destructor Documentation

vtkLine::vtkLine ( )
protected
vtkLine::~vtkLine ( )
inlineoverrideprotected

Definition at line 193 of file vtkLine.h.

Member Function Documentation

static vtkLine* vtkLine::New ( )
static
static int vtkLine::IsTypeOf ( const char *  type)
static
virtual int vtkLine::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 vtkLine* vtkLine::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkLine::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCell.

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

int vtkLine::GetCellType ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 46 of file vtkLine.h.

int vtkLine::GetCellDimension ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 47 of file vtkLine.h.

int vtkLine::GetNumberOfEdges ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 48 of file vtkLine.h.

int vtkLine::GetNumberOfFaces ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 49 of file vtkLine.h.

vtkCell* vtkLine::GetEdge ( int  )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 50 of file vtkLine.h.

vtkCell* vtkLine::GetFace ( int  )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 51 of file vtkLine.h.

int vtkLine::CellBoundary ( int  subId,
double  pcoords[3],
vtkIdList pts 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkLine::Contour ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray verts,
vtkCellArray lines,
vtkCellArray polys,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkLine::EvaluateLocation ( int subId,
double  pcoords[3],
double  x[3],
double weights 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkLine::Triangulate ( int  index,
vtkIdList ptIds,
vtkPoints pts 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

double* vtkLine::GetParametricCoords ( )
overridevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

void vtkLine::Clip ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray lines,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd,
int  insideOut 
)
overridevirtual

Clip this line using scalar value provided.

Like contouring, except that it cuts the line to produce other lines.

Implements vtkCell.

int vtkLine::GetParametricCenter ( double  pcoords[3])
inlineoverridevirtual

Return the center of the triangle in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 201 of file vtkLine.h.

int vtkLine::IntersectWithLine ( double  p1[3],
double  p2[3],
double  tol,
double t,
double  x[3],
double  pcoords[3],
int subId 
)
overridevirtual

Line-line intersection.

Intersection has to occur within [0,1] parametric coordinates and with specified tolerance.

Implements vtkCell.

static int vtkLine::Intersection ( double  p1[3],
double  p2[3],
double  x1[3],
double  x2[3],
double u,
double v 
)
static

Performs intersection of the projection of two finite 3D lines onto a 2D plane.

An intersection is found if the projection of the two lines onto the plane perpendicular to the cross product of the two lines intersect. The parameters (u,v) are the parametric coordinates of the lines at the position of closest approach.

static int vtkLine::Intersection3D ( double  p1[3],
double  p2[3],
double  x1[3],
double  x2[3],
double u,
double v 
)
static

Performs intersection of two finite 3D lines.

An intersection is found if the projection of the two lines onto the plane perpendicular to the cross product of the two lines intersect, and if the distance between the closest points of approach are within a relative tolerance. The parameters (u,v) are the parametric coordinates of the lines at the position of closest approach.

NOTE: "Unlike Intersection(), which determines whether the projections of two lines onto a plane intersect, Intersection3D() determines whether the lines themselves in 3D space intersect, within a tolerance.

static double vtkLine::DistanceToLine ( double  x[3],
double  p1[3],
double  p2[3],
double t,
double closestPoint = NULL 
)
static

Compute the distance of a point x to a finite line (p1,p2).

The method computes the parametric coordinate t and the point location on the line. Note that t is unconstrained (i.e., it may lie outside the range [0,1]) but the closest point will lie within the finite line [p1,p2], if it is defined. Also, the method returns the distance squared between x and the line (p1,p2).

static double vtkLine::DistanceToLine ( double  x[3],
double  p1[3],
double  p2[3] 
)
static

Determine the distance of the current vertex to the edge defined by the vertices provided.

Returns distance squared. Note: line is assumed infinite in extent.

static double vtkLine::DistanceBetweenLines ( double  l0[3],
double  l1[3],
double  m0[3],
double  m1[3],
double  closestPt1[3],
double  closestPt2[3],
double t1,
double t2 
)
static

Computes the shortest distance squared between two infinite lines, each defined by a pair of points (l0,l1) and (m0,m1).

Upon return, the closest points on the two line segments will be stored in closestPt1 and closestPt2. Their parametric coords (-inf <= t0, t1 <= inf) will be stored in t0 and t1. The return value is the shortest distance squared between the two line-segments.

static double vtkLine::DistanceBetweenLineSegments ( double  l0[3],
double  l1[3],
double  m0[3],
double  m1[3],
double  closestPt1[3],
double  closestPt2[3],
double t1,
double t2 
)
static

Computes the shortest distance squared between two finite line segments defined by their end points (l0,l1) and (m0,m1).

Upon return, the closest points on the two line segments will be stored in closestPt1 and closestPt2. Their parametric coords (0 <= t0, t1 <= 1) will be stored in t0 and t1. The return value is the shortest distance squared between the two line-segments.

static void vtkLine::InterpolationFunctions ( double  pcoords[3],
double  weights[2] 
)
static
Deprecated:
Replaced by vtkLine::InterpolateFunctions as of VTK 5.2
static void vtkLine::InterpolationDerivs ( double  pcoords[3],
double  derivs[2] 
)
static
Deprecated:
Replaced by vtkLine::InterpolateDerivs as of VTK 5.2
void vtkLine::InterpolateFunctions ( double  pcoords[3],
double  weights[2] 
)
inlineoverride

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

Definition at line 181 of file vtkLine.h.

void vtkLine::InterpolateDerivs ( double  pcoords[3],
double  derivs[2] 
)
inlineoverride

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

Definition at line 185 of file vtkLine.h.


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