VTK
|
parametric function for 1D interpolating splines More...
#include <vtkParametricSpline.h>
Public Types | |
typedef vtkParametricFunction | Superclass |
Public Types inherited from vtkParametricFunction | |
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... | |
vtkParametricSpline * | NewInstance () 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 *) |
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). More... | |
void | SetZSpline (vtkSpline *) |
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). More... | |
virtual vtkSpline * | GetXSpline () |
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). More... | |
virtual vtkSpline * | GetYSpline () |
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). More... | |
virtual vtkSpline * | GetZSpline () |
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). More... | |
void | SetPoints (vtkPoints *) |
Specify the list of points defining the spline. More... | |
virtual vtkPoints * | GetPoints () |
Specify the list of points defining the spline. More... | |
void | SetNumberOfPoints (vtkIdType numPts) |
Another API to set the points. More... | |
void | SetPoint (vtkIdType index, double x, double y, double z) |
Another API to set the points. More... | |
virtual void | SetClosed (int) |
Control whether the spline is open or closed. More... | |
virtual int | GetClosed () |
Control whether the spline is open or closed. More... | |
virtual void | ClosedOn () |
Control whether the spline is open or closed. More... | |
virtual void | ClosedOff () |
Control whether the spline is open or closed. More... | |
virtual void | SetParameterizeByLength (int) |
Control whether the spline is parameterized by length or by point index. More... | |
virtual int | GetParameterizeByLength () |
Control whether the spline is parameterized by length or by point index. More... | |
virtual void | ParameterizeByLengthOn () |
Control whether the spline is parameterized by length or by point index. More... | |
virtual void | ParameterizeByLengthOff () |
Control whether the spline is parameterized by length or by point index. More... | |
virtual void | SetLeftConstraint (int) |
Set the type of constraint of the left(right) end points. More... | |
virtual int | GetLeftConstraint () |
Set the type of constraint of the left(right) end points. More... | |
virtual void | SetRightConstraint (int) |
Set the type of constraint of the left(right) end points. More... | |
virtual int | GetRightConstraint () |
Set the type of constraint of the left(right) end points. More... | |
virtual void | SetLeftValue (double) |
The values of the derivative on the left and right sides. More... | |
virtual double | GetLeftValue () |
The values of the derivative on the left and right sides. More... | |
virtual void | SetRightValue (double) |
The values of the derivative on the left and right sides. More... | |
virtual double | GetRightValue () |
The values of the derivative on the left and right sides. More... | |
Public Member Functions inherited from vtkParametricFunction | |
vtkParametricFunction * | NewInstance () const |
virtual void | SetMinimumU (double) |
Set/Get the minimum u-value. More... | |
virtual double | GetMinimumU () |
Set/Get the minimum u-value. More... | |
virtual void | SetMaximumU (double) |
Set/Get the maximum u-value. More... | |
virtual double | GetMaximumU () |
Set/Get the maximum u-value. More... | |
virtual void | SetMinimumV (double) |
Set/Get the minimum v-value. More... | |
virtual double | GetMinimumV () |
Set/Get the minimum v-value. More... | |
virtual void | SetMaximumV (double) |
Set/Get the maximum v-value. More... | |
virtual double | GetMaximumV () |
Set/Get the maximum v-value. More... | |
virtual void | SetMinimumW (double) |
Set/Get the minimum w-value. More... | |
virtual double | GetMinimumW () |
Set/Get the minimum w-value. More... | |
virtual void | SetMaximumW (double) |
Set/Get the maximum w-value. More... | |
virtual double | GetMaximumW () |
Set/Get the maximum w-value. More... | |
virtual void | SetJoinU (int) |
Set/Get the flag which joins the first triangle strip to the last one. More... | |
virtual int | GetJoinU () |
Set/Get the flag which joins the first triangle strip to the last one. More... | |
virtual void | JoinUOn () |
Set/Get the flag which joins the first triangle strip to the last one. More... | |
virtual void | JoinUOff () |
Set/Get the flag which joins the first triangle strip to the last one. More... | |
virtual void | SetJoinV (int) |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual int | GetJoinV () |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual void | JoinVOn () |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual void | JoinVOff () |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual void | SetJoinW (int) |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual int | GetJoinW () |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual void | JoinWOn () |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual void | JoinWOff () |
Set/Get the flag which joins the the ends of the triangle strips. More... | |
virtual void | SetTwistU (int) |
Set/Get the flag which joins the first triangle strip to the last one with a twist. More... | |
virtual int | GetTwistU () |
Set/Get the flag which joins the first triangle strip to the last one with a twist. More... | |
virtual void | TwistUOn () |
Set/Get the flag which joins the first triangle strip to the last one with a twist. More... | |
virtual void | TwistUOff () |
Set/Get the flag which joins the first triangle strip to the last one with a twist. More... | |
virtual void | SetTwistV (int) |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual int | GetTwistV () |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual void | TwistVOn () |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual void | TwistVOff () |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual void | SetTwistW (int) |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual int | GetTwistW () |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual void | TwistWOn () |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual void | TwistWOff () |
Set/Get the flag which joins the ends of the triangle strips with a twist. More... | |
virtual void | SetClockwiseOrdering (int) |
Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More... | |
virtual int | GetClockwiseOrdering () |
Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More... | |
virtual void | ClockwiseOrderingOn () |
Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More... | |
virtual void | ClockwiseOrderingOff () |
Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More... | |
virtual void | SetDerivativesAvailable (int) |
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 int | GetDerivativesAvailable () |
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 void | DerivativesAvailableOn () |
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 void | DerivativesAvailableOff () |
Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More... | |
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... | |
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... | |
vtkCommand * | GetCommand (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 int | IsTypeOf (const char *type) |
static vtkParametricSpline * | SafeDownCast (vtkObjectBase *o) |
static vtkParametricSpline * | New () |
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 int | IsTypeOf (const char *type) |
static vtkParametricFunction * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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=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 &) |
Protected Attributes | |
vtkPoints * | Points |
vtkSpline * | XSpline |
vtkSpline * | YSpline |
vtkSpline * | ZSpline |
int | Closed |
int | LeftConstraint |
int | RightConstraint |
double | LeftValue |
double | RightValue |
int | ParameterizeByLength |
vtkMTimeType | InitializeTime |
double | Length |
double | ClosedLength |
Protected Attributes inherited from vtkParametricFunction | |
double | MinimumU |
double | MaximumU |
double | MinimumV |
double | MaximumV |
double | MinimumW |
double | MaximumW |
int | JoinU |
int | JoinV |
int | JoinW |
int | TwistU |
int | TwistV |
int | TwistW |
int | ClockwiseOrdering |
int | DerivativesAvailable |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 53 of file vtkParametricSpline.h.
Definition at line 56 of file vtkParametricSpline.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkParametricFunction.
vtkParametricSpline* vtkParametricSpline::NewInstance | ( | ) | const |
|
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.
|
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).
|
inlineoverridevirtual |
Return the parametric dimension of the class.
Implements vtkParametricFunction.
Definition at line 70 of file vtkParametricSpline.h.
Evaluate the spline at parametric coordinate u[0] returning the point coordinate Pt[3].
Implements vtkParametricFunction.
|
overridevirtual |
Evaluate a scalar value at parametric coordinate u[0] and Pt[3].
The scalar value is just the parameter u[0].
Implements vtkParametricFunction.
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.
void vtkParametricSpline::SetYSpline | ( | 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.
void vtkParametricSpline::SetZSpline | ( | 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.
|
virtual |
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.
|
virtual |
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.
|
virtual |
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.
void vtkParametricSpline::SetPoints | ( | vtkPoints * | ) |
|
virtual |
void vtkParametricSpline::SetNumberOfPoints | ( | vtkIdType | numPts | ) |
Another API to set the points.
Set the number of points and then set the individual point coordinates.
Another API to set the points.
Set the number of points and then set the individual point coordinates.
|
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.
|
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.
|
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.
|
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.
|
virtual |
Control whether the spline is parameterized by length or by point index.
Default is by length.
|
virtual |
Control whether the spline is parameterized by length or by point index.
Default is by length.
|
virtual |
Control whether the spline is parameterized by length or by point index.
Default is by length.
|
virtual |
Control whether the spline is parameterized by length or by point index.
Default is by length.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
protected |
|
protected |
Definition at line 178 of file vtkParametricSpline.h.
|
protected |
Definition at line 181 of file vtkParametricSpline.h.
|
protected |
Definition at line 182 of file vtkParametricSpline.h.
|
protected |
Definition at line 183 of file vtkParametricSpline.h.
|
protected |
Definition at line 186 of file vtkParametricSpline.h.
|
protected |
Definition at line 187 of file vtkParametricSpline.h.
|
protected |
Definition at line 188 of file vtkParametricSpline.h.
|
protected |
Definition at line 189 of file vtkParametricSpline.h.
|
protected |
Definition at line 190 of file vtkParametricSpline.h.
|
protected |
Definition at line 191 of file vtkParametricSpline.h.
|
protected |
Definition at line 194 of file vtkParametricSpline.h.
|
protected |
Definition at line 198 of file vtkParametricSpline.h.
|
protected |
Definition at line 199 of file vtkParametricSpline.h.