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

Interpolates supplied nodes with bezier line segments. More...

#include <vtkBezierContourLineInterpolator.h>

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

Public Types

typedef vtkContourLineInterpolator Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkContourLineInterpolator
typedef vtkObject Superclass
 Standard methods for instances of this class. More...
 

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...
 
vtkBezierContourLineInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int InterpolateLine (vtkRenderer *ren, vtkContourRepresentation *rep, int idx1, int idx2) override
 Subclasses that wish to interpolate a line segment must implement this. More...
 
virtual void SetMaximumCurveError (double)
 The difference between a line segment connecting two points and the curve connecting the same points. More...
 
virtual double GetMaximumCurveError ()
 
virtual void SetMaximumCurveLineSegments (int)
 Maximum number of bezier line segments between two nodes. More...
 
virtual int GetMaximumCurveLineSegments ()
 
void GetSpan (int nodeIndex, vtkIntArray *nodeIndices, vtkContourRepresentation *rep) override
 Span of the interpolator, i.e. More...
 
- Public Member Functions inherited from vtkContourLineInterpolator
vtkContourLineInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int UpdateNode (vtkRenderer *, vtkContourRepresentation *, double *vtkNotUsed(node), int vtkNotUsed(idx))
 The interpolator is given a chance to update the node. 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...
 
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 vtkBezierContourLineInterpolatorNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBezierContourLineInterpolatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkContourLineInterpolator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContourLineInterpolatorSafeDownCast (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
 
 vtkBezierContourLineInterpolator ()
 
 ~vtkBezierContourLineInterpolator () override
 
void ComputeMidpoint (double p1[3], double p2[3], double mid[3])
 
- Protected Member Functions inherited from vtkContourLineInterpolator
 vtkContourLineInterpolator ()
 
 ~vtkContourLineInterpolator () 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

double MaximumCurveError
 
int MaximumCurveLineSegments
 
- 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

Interpolates supplied nodes with bezier line segments.

The line interpolator interpolates supplied nodes (see InterpolateLine) with Bezier line segments. The fitness of the curve may be controlled using SetMaximumCurveError and SetMaximumNumberOfLineSegments.

See also
vtkContourLineInterpolator

Definition at line 33 of file vtkBezierContourLineInterpolator.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 46 of file vtkBezierContourLineInterpolator.h.

Constructor & Destructor Documentation

◆ vtkBezierContourLineInterpolator()

vtkBezierContourLineInterpolator::vtkBezierContourLineInterpolator ( )
protected

◆ ~vtkBezierContourLineInterpolator()

vtkBezierContourLineInterpolator::~vtkBezierContourLineInterpolator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBezierContourLineInterpolator* vtkBezierContourLineInterpolator::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkBezierContourLineInterpolator::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 vtkContourLineInterpolator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBezierContourLineInterpolator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContourLineInterpolator.

◆ NewInstance()

vtkBezierContourLineInterpolator* vtkBezierContourLineInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkBezierContourLineInterpolator::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 vtkObject.

◆ InterpolateLine()

int vtkBezierContourLineInterpolator::InterpolateLine ( vtkRenderer ren,
vtkContourRepresentation rep,
int  idx1,
int  idx2 
)
overridevirtual

Subclasses that wish to interpolate a line segment must implement this.

For instance vtkBezierContourLineInterpolator adds nodes between idx1 and idx2, that allow the contour to adhere to a bezier curve.

Implements vtkContourLineInterpolator.

◆ SetMaximumCurveError()

virtual void vtkBezierContourLineInterpolator::SetMaximumCurveError ( double  )
virtual

The difference between a line segment connecting two points and the curve connecting the same points.

In the limit of the length of the curve dx -> 0, the two values will be the same. The smaller this number, the finer the bezier curve will be interpolated. Default is 0.005

◆ GetMaximumCurveError()

virtual double vtkBezierContourLineInterpolator::GetMaximumCurveError ( )
virtual

◆ SetMaximumCurveLineSegments()

virtual void vtkBezierContourLineInterpolator::SetMaximumCurveLineSegments ( int  )
virtual

Maximum number of bezier line segments between two nodes.

Larger values create a finer interpolation. Default is 100.

◆ GetMaximumCurveLineSegments()

virtual int vtkBezierContourLineInterpolator::GetMaximumCurveLineSegments ( )
virtual

◆ GetSpan()

void vtkBezierContourLineInterpolator::GetSpan ( int  nodeIndex,
vtkIntArray nodeIndices,
vtkContourRepresentation rep 
)
overridevirtual

Span of the interpolator, i.e.

the number of control points it's supposed to interpolate given a node.

The first argument is the current nodeIndex. i.e., you'd be trying to interpolate between nodes "nodeIndex" and "nodeIndex-1", unless you're closing the contour, in which case you're trying to interpolate "nodeIndex" and "Node=0". The node span is returned in a vtkIntArray.

The node span is returned in a vtkIntArray. The node span returned by this interpolator will be a 2-tuple with a span of 4.

Reimplemented from vtkContourLineInterpolator.

◆ ComputeMidpoint()

void vtkBezierContourLineInterpolator::ComputeMidpoint ( double  p1[3],
double  p2[3],
double  mid[3] 
)
inlineprotected

Definition at line 91 of file vtkBezierContourLineInterpolator.h.

Member Data Documentation

◆ MaximumCurveError

double vtkBezierContourLineInterpolator::MaximumCurveError
protected

Definition at line 98 of file vtkBezierContourLineInterpolator.h.

◆ MaximumCurveLineSegments

int vtkBezierContourLineInterpolator::MaximumCurveLineSegments
protected

Definition at line 99 of file vtkBezierContourLineInterpolator.h.


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