VTK  9.2.20230126
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCoordinateFrame Class Reference

implicit function for a right-handed coordinate system More...

#include <vtkCoordinateFrame.h>

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

Public Member Functions

void EvaluateGradient (double x[3], double n[3]) override
 Evaluate coordinate frame gradient. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate plane equations. More...
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate plane equations. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate plane equations. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate plane equations. More...
 
virtual void SetOrigin (double, double, double)
 Specify the point through which all 3 planes pass. More...
 
virtual void SetOrigin (double[3])
 Specify the point through which all 3 planes pass. More...
 
virtual double * GetOrigin ()
 Specify the point through which all 3 planes pass. More...
 
virtual void GetOrigin (double &, double &, double &)
 Specify the point through which all 3 planes pass. More...
 
virtual void GetOrigin (double[3])
 Specify the point through which all 3 planes pass. More...
 
virtual void SetXAxis (double, double, double)
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void SetXAxis (double[3])
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual double * GetXAxis ()
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void GetXAxis (double &, double &, double &)
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void GetXAxis (double[3])
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void SetYAxis (double, double, double)
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void SetYAxis (double[3])
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual double * GetYAxis ()
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void GetYAxis (double &, double &, double &)
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void GetYAxis (double[3])
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void SetZAxis (double, double, double)
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void SetZAxis (double[3])
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual double * GetZAxis ()
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void GetZAxis (double &, double &, double &)
 Specify a list of unit-length normal vectors for each plane. More...
 
virtual void GetZAxis (double[3])
 Specify a list of unit-length normal vectors for each plane. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Overload standard modified time function. More...
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (const double x[3])
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value. More...
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
double * FunctionGradient (const double x[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
double * FunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void SetTransform (const double elements[16])
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual vtkAbstractTransformGetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate function at position x-y-z and return value. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Protected Member Functions

 vtkCoordinateFrame ()=default
 
 ~vtkCoordinateFrame () override=default
 
- Protected Member Functions inherited from vtkImplicitFunction
 vtkImplicitFunction ()
 
 ~vtkImplicitFunction () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Origin [3] = { 0, 0, 0 }
 
double XAxis [3] = { 1, 0, 0 }
 
double YAxis [3] = { 0, 1, 0 }
 
double ZAxis [3] = { 0, 0, 1 }
 
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
 
double ReturnValue [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkImplicitFunction Superclass
 Standard methods for instantiation, type information, and printing. More...
 
static vtkCoordinateFrameNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, type information, and printing. More...
 
static vtkCoordinateFrameSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, type information, and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, type information, and printing. More...
 
vtkCoordinateFrameNewInstance () const
 Standard methods for instantiation, type information, and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, type information, and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, type information, and printing. More...
 

Additional Inherited Members

- Public Types inherited from vtkImplicitFunction
typedef vtkObject Superclass
 
- Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

implicit function for a right-handed coordinate system

vtkCoordinateFrame computes an implicit function and function gradient for a set of 3 orthogonal planes.

The function evaluates to a combination of quartic spherical harmonic basis functions: \(\sqrt(\frac{7}{12})*Y_{4,0} + \sqrt(\frac{5}{12})*Y_{4,4}\) that – when evaluated on a unit sphere centered at the coordinate frame's origin – form a 6-lobed function with a maximum along each of the 6 axes (3 positive, 3 negative). This function is frequently used in frame-field design.

See the paper "On Smooth Frame Field Design" by Nicolas Ray and Dmitry Sokolov (2016, hal-01245657, https://hal.inria.fr/hal-01245657/file/framefield.pdf ) for more information.

Tests:
vtkCoordinateFrame (Tests)

Definition at line 49 of file vtkCoordinateFrame.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 57 of file vtkCoordinateFrame.h.

Constructor & Destructor Documentation

◆ vtkCoordinateFrame()

vtkCoordinateFrame::vtkCoordinateFrame ( )
protecteddefault

◆ ~vtkCoordinateFrame()

vtkCoordinateFrame::~vtkCoordinateFrame ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkCoordinateFrame* vtkCoordinateFrame::New ( )
static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

Standard methods for instantiation, type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkCoordinateFrame::IsA ( const char *  type)
virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

◆ SafeDownCast()

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

Standard methods for instantiation, type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCoordinateFrame::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkCoordinateFrame* vtkCoordinateFrame::NewInstance ( ) const

Standard methods for instantiation, type information, and printing.

◆ PrintSelf()

void vtkCoordinateFrame::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkObject.

◆ EvaluateFunction() [1/4]

double vtkCoordinateFrame::EvaluateFunction ( double  x[3])
overridevirtual

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

Implements vtkImplicitFunction.

◆ EvaluateGradient()

void vtkCoordinateFrame::EvaluateGradient ( double  x[3],
double  n[3] 
)
overridevirtual

Evaluate coordinate frame gradient.

n is the output gradient evaluated at point x.

Implements vtkImplicitFunction.

◆ SetOrigin() [1/2]

virtual void vtkCoordinateFrame::SetOrigin ( double  ,
double  ,
double   
)
virtual

Specify the point through which all 3 planes pass.

◆ SetOrigin() [2/2]

virtual void vtkCoordinateFrame::SetOrigin ( double  [3])
virtual

Specify the point through which all 3 planes pass.

◆ GetOrigin() [1/3]

virtual double* vtkCoordinateFrame::GetOrigin ( )
virtual

Specify the point through which all 3 planes pass.

◆ GetOrigin() [2/3]

virtual void vtkCoordinateFrame::GetOrigin ( double &  ,
double &  ,
double &   
)
virtual

Specify the point through which all 3 planes pass.

◆ GetOrigin() [3/3]

virtual void vtkCoordinateFrame::GetOrigin ( double  [3])
virtual

Specify the point through which all 3 planes pass.

◆ SetXAxis() [1/2]

virtual void vtkCoordinateFrame::SetXAxis ( double  ,
double  ,
double   
)
virtual

Specify a list of unit-length normal vectors for each plane.

◆ SetXAxis() [2/2]

virtual void vtkCoordinateFrame::SetXAxis ( double  [3])
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetXAxis() [1/3]

virtual double* vtkCoordinateFrame::GetXAxis ( )
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetXAxis() [2/3]

virtual void vtkCoordinateFrame::GetXAxis ( double &  ,
double &  ,
double &   
)
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetXAxis() [3/3]

virtual void vtkCoordinateFrame::GetXAxis ( double  [3])
virtual

Specify a list of unit-length normal vectors for each plane.

◆ SetYAxis() [1/2]

virtual void vtkCoordinateFrame::SetYAxis ( double  ,
double  ,
double   
)
virtual

Specify a list of unit-length normal vectors for each plane.

◆ SetYAxis() [2/2]

virtual void vtkCoordinateFrame::SetYAxis ( double  [3])
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetYAxis() [1/3]

virtual double* vtkCoordinateFrame::GetYAxis ( )
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetYAxis() [2/3]

virtual void vtkCoordinateFrame::GetYAxis ( double &  ,
double &  ,
double &   
)
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetYAxis() [3/3]

virtual void vtkCoordinateFrame::GetYAxis ( double  [3])
virtual

Specify a list of unit-length normal vectors for each plane.

◆ SetZAxis() [1/2]

virtual void vtkCoordinateFrame::SetZAxis ( double  ,
double  ,
double   
)
virtual

Specify a list of unit-length normal vectors for each plane.

◆ SetZAxis() [2/2]

virtual void vtkCoordinateFrame::SetZAxis ( double  [3])
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetZAxis() [1/3]

virtual double* vtkCoordinateFrame::GetZAxis ( )
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetZAxis() [2/3]

virtual void vtkCoordinateFrame::GetZAxis ( double &  ,
double &  ,
double &   
)
virtual

Specify a list of unit-length normal vectors for each plane.

◆ GetZAxis() [3/3]

virtual void vtkCoordinateFrame::GetZAxis ( double  [3])
virtual

Specify a list of unit-length normal vectors for each plane.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

Evaluate plane equations.

Return largest value (i.e., an intersection operation between all planes).

Definition at line 143 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Origin

double vtkCoordinateFrame::Origin[3] = { 0, 0, 0 }
protected

Definition at line 101 of file vtkCoordinateFrame.h.

◆ XAxis

double vtkCoordinateFrame::XAxis[3] = { 1, 0, 0 }
protected

Definition at line 102 of file vtkCoordinateFrame.h.

◆ YAxis

double vtkCoordinateFrame::YAxis[3] = { 0, 1, 0 }
protected

Definition at line 103 of file vtkCoordinateFrame.h.

◆ ZAxis

double vtkCoordinateFrame::ZAxis[3] = { 0, 0, 1 }
protected

Definition at line 104 of file vtkCoordinateFrame.h.


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