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

Contour interpolator for DEM data. More...

#include <vtkTerrainContourLineInterpolator.h>

Inheritance diagram for vtkTerrainContourLineInterpolator:
[legend]
Collaboration diagram for vtkTerrainContourLineInterpolator:
[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...
 
vtkTerrainContourLineInterpolatorNewInstance () 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
 Interpolate to create lines between contour nodes idx1 and idx2. More...
 
int UpdateNode (vtkRenderer *, vtkContourRepresentation *, double *vtkNotUsed(node), int vtkNotUsed(idx)) override
 The interpolator is given a chance to update the node. More...
 
virtual void SetImageData (vtkImageData *)
 Set the height field data. More...
 
virtual vtkImageDataGetImageData ()
 
virtual vtkProjectedTerrainPathGetProjector ()
 Get the vtkProjectedTerrainPath operator used to project the terrain onto the data. More...
 
- Public Member Functions inherited from vtkContourLineInterpolator
vtkContourLineInterpolatorNewInstance () const
 
virtual void GetSpan (int nodeIndex, vtkIntArray *nodeIndices, vtkContourRepresentation *rep)
 Span of the interpolator. 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 vtkTerrainContourLineInterpolatorNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTerrainContourLineInterpolatorSafeDownCast (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
 
 vtkTerrainContourLineInterpolator ()
 
 ~vtkTerrainContourLineInterpolator () override
 
- 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

vtkImageDataImageData
 
vtkProjectedTerrainPathProjector
 
- 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

Contour interpolator for DEM data.

vtkTerrainContourLineInterpolator interpolates nodes on height field data. The class is meant to be used in conjunciton with a vtkContourWidget, enabling you to draw paths on terrain data. The class internally uses a vtkProjectedTerrainPath. Users can set kind of interpolation desired between two node points by setting the modes of the this filter. For instance:

contourRepresentation->SetLineInterpolator(interpolator);
interpolator->SetImageData( demDataFile );
interpolator->GetProjector()->SetProjectionModeToHug();
interpolator->SetHeightOffset(25.0);

You are required to set the ImageData to this class as the height-field image.

See also
vtkTerrainDataPointPlacer vtkProjectedTerrainPath

Definition at line 50 of file vtkTerrainContourLineInterpolator.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 63 of file vtkTerrainContourLineInterpolator.h.

Constructor & Destructor Documentation

◆ vtkTerrainContourLineInterpolator()

vtkTerrainContourLineInterpolator::vtkTerrainContourLineInterpolator ( )
protected

◆ ~vtkTerrainContourLineInterpolator()

vtkTerrainContourLineInterpolator::~vtkTerrainContourLineInterpolator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTerrainContourLineInterpolator* vtkTerrainContourLineInterpolator::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTerrainContourLineInterpolator::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 vtkTerrainContourLineInterpolator* vtkTerrainContourLineInterpolator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTerrainContourLineInterpolator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContourLineInterpolator.

◆ NewInstance()

vtkTerrainContourLineInterpolator* vtkTerrainContourLineInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkTerrainContourLineInterpolator::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 vtkContourLineInterpolator.

◆ InterpolateLine()

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

Interpolate to create lines between contour nodes idx1 and idx2.

Depending on the projection mode, the interpolated line may either hug the terrain, just connect the two points with a straight line or a non-occluded interpolation. Used internally by vtkContourRepresentation.

Implements vtkContourLineInterpolator.

◆ UpdateNode()

int vtkTerrainContourLineInterpolator::UpdateNode ( vtkRenderer ,
vtkContourRepresentation ,
double *  vtkNotUsednode,
int   vtkNotUsedidx 
)
overridevirtual

The interpolator is given a chance to update the node.

Used internally by vtkContourRepresentation Returns 0 if the node (world position) is unchanged.

Reimplemented from vtkContourLineInterpolator.

◆ SetImageData()

virtual void vtkTerrainContourLineInterpolator::SetImageData ( vtkImageData )
virtual

Set the height field data.

The height field data is a 2D image. The scalars in the image represent the height field. This must be set.

◆ GetImageData()

virtual vtkImageData* vtkTerrainContourLineInterpolator::GetImageData ( )
virtual

◆ GetProjector()

virtual vtkProjectedTerrainPath* vtkTerrainContourLineInterpolator::GetProjector ( )
virtual

Get the vtkProjectedTerrainPath operator used to project the terrain onto the data.

This operator has several modes, See the documentation of vtkProjectedTerrainPath. The default mode is to hug the terrain data at 0 height offset.

Member Data Documentation

◆ ImageData

vtkImageData* vtkTerrainContourLineInterpolator::ImageData
protected

Definition at line 107 of file vtkTerrainContourLineInterpolator.h.

◆ Projector

vtkProjectedTerrainPath* vtkTerrainContourLineInterpolator::Projector
protected

Definition at line 108 of file vtkTerrainContourLineInterpolator.h.


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