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

parametric function for 1D interpolating splines More...

#include <vtkParametricSpline.h>

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

Public Types

typedef vtkParametricFunction Superclass
 
- Public Types inherited from vtkParametricFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkParametricSplineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetDimension () override
 Return the parametric dimension of the class. More...
 
void Evaluate (double u[3], double Pt[3], double Du[9]) override
 Evaluate the spline at parametric coordinate u[0] returning the point coordinate Pt[3]. More...
 
double EvaluateScalar (double u[3], double Pt[3], double Du[9]) override
 Evaluate a scalar value at parametric coordinate u[0] and Pt[3]. More...
 
void SetXSpline (vtkSpline *)
 By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). More...
 
void SetYSpline (vtkSpline *)
 
void SetZSpline (vtkSpline *)
 
virtual vtkSplineGetXSpline ()
 
virtual vtkSplineGetYSpline ()
 
virtual vtkSplineGetZSpline ()
 
void SetPoints (vtkPoints *)
 Specify the list of points defining the spline. More...
 
virtual vtkPointsGetPoints ()
 
void SetNumberOfPoints (vtkIdType numPts)
 Another API to set the points. More...
 
void SetPoint (vtkIdType index, double x, double y, double z)
 
virtual void SetClosed (vtkTypeBool)
 Control whether the spline is open or closed. More...
 
virtual vtkTypeBool GetClosed ()
 
virtual void ClosedOn ()
 
virtual void ClosedOff ()
 
virtual void SetParameterizeByLength (vtkTypeBool)
 Control whether the spline is parameterized by length or by point index. More...
 
virtual vtkTypeBool GetParameterizeByLength ()
 
virtual void ParameterizeByLengthOn ()
 
virtual void ParameterizeByLengthOff ()
 
virtual void SetLeftConstraint (int)
 Set the type of constraint of the left(right) end points. More...
 
virtual int GetLeftConstraint ()
 
virtual void SetRightConstraint (int)
 
virtual int GetRightConstraint ()
 
virtual void SetLeftValue (double)
 The values of the derivative on the left and right sides. More...
 
virtual double GetLeftValue ()
 
virtual void SetRightValue (double)
 
virtual double GetRightValue ()
 
- Public Member Functions inherited from vtkParametricFunction
vtkParametricFunctionNewInstance () const
 
virtual void SetMinimumU (double)
 Set/Get the minimum u-value. More...
 
virtual double GetMinimumU ()
 
virtual void SetMaximumU (double)
 Set/Get the maximum u-value. More...
 
virtual double GetMaximumU ()
 
virtual void SetMinimumV (double)
 Set/Get the minimum v-value. More...
 
virtual double GetMinimumV ()
 
virtual void SetMaximumV (double)
 Set/Get the maximum v-value. More...
 
virtual double GetMaximumV ()
 
virtual void SetMinimumW (double)
 Set/Get the minimum w-value. More...
 
virtual double GetMinimumW ()
 
virtual void SetMaximumW (double)
 Set/Get the maximum w-value. More...
 
virtual double GetMaximumW ()
 
virtual void SetJoinU (vtkTypeBool)
 Set/Get the flag which joins the first triangle strip to the last one. More...
 
virtual vtkTypeBool GetJoinU ()
 
virtual void JoinUOn ()
 
virtual void JoinUOff ()
 
virtual void SetJoinV (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips. More...
 
virtual vtkTypeBool GetJoinV ()
 
virtual void JoinVOn ()
 
virtual void JoinVOff ()
 
virtual void SetJoinW (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips. More...
 
virtual vtkTypeBool GetJoinW ()
 
virtual void JoinWOn ()
 
virtual void JoinWOff ()
 
virtual void SetTwistU (vtkTypeBool)
 Set/Get the flag which joins the first triangle strip to the last one with a twist. More...
 
virtual vtkTypeBool GetTwistU ()
 
virtual void TwistUOn ()
 
virtual void TwistUOff ()
 
virtual void SetTwistV (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips with a twist. More...
 
virtual vtkTypeBool GetTwistV ()
 
virtual void TwistVOn ()
 
virtual void TwistVOff ()
 
virtual void SetTwistW (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips with a twist. More...
 
virtual vtkTypeBool GetTwistW ()
 
virtual void TwistWOn ()
 
virtual void TwistWOff ()
 
virtual void SetClockwiseOrdering (vtkTypeBool)
 Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...
 
virtual vtkTypeBool GetClockwiseOrdering ()
 
virtual void ClockwiseOrderingOn ()
 
virtual void ClockwiseOrderingOff ()
 
virtual void SetDerivativesAvailable (vtkTypeBool)
 Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...
 
virtual vtkTypeBool GetDerivativesAvailable ()
 
virtual void DerivativesAvailableOn ()
 
virtual void DerivativesAvailableOff ()
 
- 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 PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParametricSplineSafeDownCast (vtkObjectBase *o)
 
static vtkParametricSplineNew ()
 Construct the spline with the following parameters: MinimumU = 0, MaximumU = 1, JoinU = 0 (unless the spline is closed, then JoinU = 1), TwistU = 0, DerivativesSupplied = 0 (the other vtkParametricFunction parameters are ignored). More...
 
- Static Public Member Functions inherited from vtkParametricFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkParametricSpline ()
 
 ~vtkParametricSpline () override
 
int Initialize ()
 
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
 
 ~vtkParametricFunction () 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. More...
 
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

vtkPointsPoints
 
vtkSplineXSpline
 
vtkSplineYSpline
 
vtkSplineZSpline
 
vtkTypeBool Closed
 
int LeftConstraint
 
int RightConstraint
 
double LeftValue
 
double RightValue
 
vtkTypeBool ParameterizeByLength
 
vtkMTimeType InitializeTime
 
double Length
 
double ClosedLength
 
- Protected Attributes inherited from vtkParametricFunction
double MinimumU
 
double MaximumU
 
double MinimumV
 
double MaximumV
 
double MinimumW
 
double MaximumW
 
vtkTypeBool JoinU
 
vtkTypeBool JoinV
 
vtkTypeBool JoinW
 
vtkTypeBool TwistU
 
vtkTypeBool TwistV
 
vtkTypeBool TwistW
 
vtkTypeBool ClockwiseOrdering
 
vtkTypeBool DerivativesAvailable
 
- 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

parametric function for 1D interpolating splines

vtkParametricSpline is a parametric function for 1D interpolating splines. vtkParametricSpline maps the single parameter u into a 3D point (x,y,z) using three instances of interpolating splines. This family of 1D splines is guaranteed to be parameterized in the interval [0,1]. Attempting to evaluate outside this interval will cause the parameter u to be clamped in the range [0,1].

When constructed, this class creates instances of vtkCardinalSpline for each of the x-y-z coordinates. The user may choose to replace these with their own instances of subclasses of vtkSpline.

Warning
If you wish to tessellate the spline, use the class vtkParametricFunctionSource.
See also
vtkSpline vtkKochanekSpline vtkCardinalSpline
Examples:
vtkParametricSpline (Examples)
Tests:
vtkParametricSpline (Tests)

Definition at line 53 of file vtkParametricSpline.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkParametricSpline.h.

Constructor & Destructor Documentation

◆ vtkParametricSpline()

vtkParametricSpline::vtkParametricSpline ( )
protected

◆ ~vtkParametricSpline()

vtkParametricSpline::~vtkParametricSpline ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkParametricSpline::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 vtkParametricFunction.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkParametricSpline::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkParametricFunction.

◆ NewInstance()

vtkParametricSpline* vtkParametricSpline::NewInstance ( ) const

◆ PrintSelf()

void vtkParametricSpline::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 vtkParametricFunction.

◆ New()

static vtkParametricSpline* vtkParametricSpline::New ( )
static

Construct the spline with the following parameters: MinimumU = 0, MaximumU = 1, JoinU = 0 (unless the spline is closed, then JoinU = 1), TwistU = 0, DerivativesSupplied = 0 (the other vtkParametricFunction parameters are ignored).

◆ GetDimension()

int vtkParametricSpline::GetDimension ( )
inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 70 of file vtkParametricSpline.h.

◆ Evaluate()

void vtkParametricSpline::Evaluate ( double  u[3],
double  Pt[3],
double  Du[9] 
)
overridevirtual

Evaluate the spline at parametric coordinate u[0] returning the point coordinate Pt[3].

Implements vtkParametricFunction.

◆ EvaluateScalar()

double vtkParametricSpline::EvaluateScalar ( double  u[3],
double  Pt[3],
double  Du[9] 
)
overridevirtual

Evaluate a scalar value at parametric coordinate u[0] and Pt[3].

The scalar value is just the parameter u[0].

Implements vtkParametricFunction.

◆ SetXSpline()

void vtkParametricSpline::SetXSpline ( vtkSpline )

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).

The user may choose to create and assign their own instances of vtkSpline.

◆ SetYSpline()

void vtkParametricSpline::SetYSpline ( vtkSpline )

◆ SetZSpline()

void vtkParametricSpline::SetZSpline ( vtkSpline )

◆ GetXSpline()

virtual vtkSpline* vtkParametricSpline::GetXSpline ( )
virtual

◆ GetYSpline()

virtual vtkSpline* vtkParametricSpline::GetYSpline ( )
virtual

◆ GetZSpline()

virtual vtkSpline* vtkParametricSpline::GetZSpline ( )
virtual

◆ SetPoints()

void vtkParametricSpline::SetPoints ( vtkPoints )

Specify the list of points defining the spline.

Do this by specifying a vtkPoints array containing the points. Note that the order of the points in vtkPoints is the order that the splines will be fit.

◆ GetPoints()

virtual vtkPoints* vtkParametricSpline::GetPoints ( )
virtual

◆ SetNumberOfPoints()

void vtkParametricSpline::SetNumberOfPoints ( vtkIdType  numPts)

Another API to set the points.

Set the number of points and then set the individual point coordinates.

◆ SetPoint()

void vtkParametricSpline::SetPoint ( vtkIdType  index,
double  x,
double  y,
double  z 
)

◆ SetClosed()

virtual void vtkParametricSpline::SetClosed ( vtkTypeBool  )
virtual

Control whether the spline is open or closed.

A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

◆ GetClosed()

virtual vtkTypeBool vtkParametricSpline::GetClosed ( )
virtual

◆ ClosedOn()

virtual void vtkParametricSpline::ClosedOn ( )
virtual

◆ ClosedOff()

virtual void vtkParametricSpline::ClosedOff ( )
virtual

◆ SetParameterizeByLength()

virtual void vtkParametricSpline::SetParameterizeByLength ( vtkTypeBool  )
virtual

Control whether the spline is parameterized by length or by point index.

Default is by length.

◆ GetParameterizeByLength()

virtual vtkTypeBool vtkParametricSpline::GetParameterizeByLength ( )
virtual

◆ ParameterizeByLengthOn()

virtual void vtkParametricSpline::ParameterizeByLengthOn ( )
virtual

◆ ParameterizeByLengthOff()

virtual void vtkParametricSpline::ParameterizeByLengthOff ( )
virtual

◆ SetLeftConstraint()

virtual void vtkParametricSpline::SetLeftConstraint ( int  )
virtual

Set the type of constraint of the left(right) end points.

Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

◆ GetLeftConstraint()

virtual int vtkParametricSpline::GetLeftConstraint ( )
virtual

◆ SetRightConstraint()

virtual void vtkParametricSpline::SetRightConstraint ( int  )
virtual

◆ GetRightConstraint()

virtual int vtkParametricSpline::GetRightConstraint ( )
virtual

◆ SetLeftValue()

virtual void vtkParametricSpline::SetLeftValue ( double  )
virtual

The values of the derivative on the left and right sides.

The value is used only if the left(right) constraint is type 1-3.

◆ GetLeftValue()

virtual double vtkParametricSpline::GetLeftValue ( )
virtual

◆ SetRightValue()

virtual void vtkParametricSpline::SetRightValue ( double  )
virtual

◆ GetRightValue()

virtual double vtkParametricSpline::GetRightValue ( )
virtual

◆ Initialize()

int vtkParametricSpline::Initialize ( )
protected

Member Data Documentation

◆ Points

vtkPoints* vtkParametricSpline::Points
protected

Definition at line 178 of file vtkParametricSpline.h.

◆ XSpline

vtkSpline* vtkParametricSpline::XSpline
protected

Definition at line 181 of file vtkParametricSpline.h.

◆ YSpline

vtkSpline* vtkParametricSpline::YSpline
protected

Definition at line 182 of file vtkParametricSpline.h.

◆ ZSpline

vtkSpline* vtkParametricSpline::ZSpline
protected

Definition at line 183 of file vtkParametricSpline.h.

◆ Closed

vtkTypeBool vtkParametricSpline::Closed
protected

Definition at line 186 of file vtkParametricSpline.h.

◆ LeftConstraint

int vtkParametricSpline::LeftConstraint
protected

Definition at line 187 of file vtkParametricSpline.h.

◆ RightConstraint

int vtkParametricSpline::RightConstraint
protected

Definition at line 188 of file vtkParametricSpline.h.

◆ LeftValue

double vtkParametricSpline::LeftValue
protected

Definition at line 189 of file vtkParametricSpline.h.

◆ RightValue

double vtkParametricSpline::RightValue
protected

Definition at line 190 of file vtkParametricSpline.h.

◆ ParameterizeByLength

vtkTypeBool vtkParametricSpline::ParameterizeByLength
protected

Definition at line 191 of file vtkParametricSpline.h.

◆ InitializeTime

vtkMTimeType vtkParametricSpline::InitializeTime
protected

Definition at line 194 of file vtkParametricSpline.h.

◆ Length

double vtkParametricSpline::Length
protected

Definition at line 198 of file vtkParametricSpline.h.

◆ ClosedLength

double vtkParametricSpline::ClosedLength
protected

Definition at line 199 of file vtkParametricSpline.h.


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