vtkTerrainDataPointPlacer Class Reference

Place points on terrain data. More...

#include <vtkTerrainDataPointPlacer.h>

Inheritance diagram for vtkTerrainDataPointPlacer:

Collaboration diagram for vtkTerrainDataPointPlacer:

Public Member Functions
virtual void	AddProp (vtkProp *)
virtual void	RemoveAllProps ()
int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9]) override
	Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed.
int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9]) override
	Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point.
int	ValidateWorldPosition (double worldPos[3]) override
	Given a world position check the validity of this position according to the constraints of the placer.
int	ValidateDisplayPosition (vtkRenderer *, double displayPos[2]) override
	Given a display position, check the validity of this position.
int	ValidateWorldPosition (double worldPos[3], double worldOrient[9]) override
	Given a world position and a world orientation, validate it according to the constraints of the placer.
virtual void	SetHeightOffset (double)
	This is the height above (or below) the terrain that the dictated point should be placed.
virtual double	GetHeightOffset ()
	This is the height above (or below) the terrain that the dictated point should be placed.
virtual vtkPropPicker *	GetPropPicker ()
	Get the Prop picker.
Public Member Functions inherited from vtkPointPlacer
virtual int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
	Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed.
virtual int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9])
	Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point.
virtual int	ValidateWorldPosition (double worldPos[3])
	Given a world position check the validity of this position according to the constraints of the placer.
virtual int	ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
	Given a display position, check the validity of this position.
virtual int	ValidateWorldPosition (double worldPos[3], double worldOrient[9])
	Given a world position and a world orientation, validate it according to the constraints of the placer.
virtual int	UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
	Given a current renderer, world position and orientation, update them according to the constraints of the placer.
virtual int	UpdateNodeWorldPosition (double worldPos[3], vtkIdType nodePointId)
	Give the placer a chance to update the node information, if any.
virtual int	UpdateInternalState ()
	Called by the representation to give the placer a chance to update itself.
virtual void	SetPixelTolerance (int)
	Set/get the tolerance used when performing computations in display coordinates.
virtual int	GetPixelTolerance ()
	Set/get the tolerance used when performing computations in display coordinates.
virtual void	SetWorldTolerance (double)
	Set/get the tolerance used when performing computations in world coordinates.
virtual double	GetWorldTolerance ()
	Set/get the tolerance used when performing computations in world coordinates.
vtkPointPlacer *	NewInstance () const
	Standard methods for instances of this class.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTerrainDataPointPlacer *	New ()
	Instantiate this class.
Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacer *	New ()
	Instantiate this class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkPointPlacer *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
	vtkTerrainDataPointPlacer ()
	~vtkTerrainDataPointPlacer () override
Protected Member Functions inherited from vtkPointPlacer
	vtkPointPlacer ()
	~vtkPointPlacer () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPropCollection *	TerrainProps
vtkPropPicker *	PropPicker
double	HeightOffset
Protected Attributes inherited from vtkPointPlacer
int	PixelTolerance
double	WorldTolerance
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 vtkPointPlacer	Superclass
	Standard methods for instances of this class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkTerrainDataPointPlacer *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instances of this class.
vtkTerrainDataPointPlacer *	NewInstance () const
	Standard methods for instances of this class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class.

Additional Inherited Members
Public Types inherited from vtkPointPlacer
typedef vtkObject	Superclass
	Standard methods for instances of this class.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Place points on terrain data.

vtkTerrainDataPointPlacer dictates the placement of points on height field data. The class takes as input the list of props that represent the terrain in a rendered scene. A height offset can be specified to dicatate the placement of points at a certain height above the surface.

Usage:

A typical usage of this class is as follows:

pointPlacer->AddProp(demActor);    // the actor(s) containing the terrain.
rep->SetPointPlacer(pointPlacer);
pointPlacer->SetHeightOffset( 100 );

See also

vtkPointPlacer vtkTerrainContourLineInterpolator

Tests:

vtkTerrainDataPointPlacer (Tests)

Definition at line 39 of file vtkTerrainDataPointPlacer.h.

Member Typedef Documentation

Superclass

typedef vtkPointPlacer vtkTerrainDataPointPlacer::Superclass

Standard methods for instances of this class.

Definition at line 51 of file vtkTerrainDataPointPlacer.h.

Constructor & Destructor Documentation

vtkTerrainDataPointPlacer()

vtkTerrainDataPointPlacer::vtkTerrainDataPointPlacer ( )

protected

~vtkTerrainDataPointPlacer()

vtkTerrainDataPointPlacer::~vtkTerrainDataPointPlacer ( )

overrideprotected

Member Function Documentation

New()

static vtkTerrainDataPointPlacer * vtkTerrainDataPointPlacer::New ( )

static

Instantiate this class.

IsTypeOf()

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

static

Standard methods for instances of this class.

IsA()

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

SafeDownCast()

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

static

Standard methods for instances of this class.

NewInstanceInternal()

virtual vtkObjectBase * vtkTerrainDataPointPlacer::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

NewInstance()

vtkTerrainDataPointPlacer * vtkTerrainDataPointPlacer::NewInstance

(

)

const

Standard methods for instances of this class.

PrintSelf()

void vtkTerrainDataPointPlacer::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

AddProp()

virtual void vtkTerrainDataPointPlacer::AddProp ( vtkProp *  )

virtual

RemoveAllProps()

virtual void vtkTerrainDataPointPlacer::RemoveAllProps ( )

virtual

SetHeightOffset()

virtual void vtkTerrainDataPointPlacer::SetHeightOffset ( double  )

virtual

This is the height above (or below) the terrain that the dictated point should be placed.

Positive values indicate distances above the terrain; negative values indicate distances below the terrain. The default is 0.0.

GetHeightOffset()

virtual double vtkTerrainDataPointPlacer::GetHeightOffset ( )

virtual

This is the height above (or below) the terrain that the dictated point should be placed.

Positive values indicate distances above the terrain; negative values indicate distances below the terrain. The default is 0.0.

ComputeWorldPosition() [1/2]

int vtkTerrainDataPointPlacer::ComputeWorldPosition ( vtkRenderer *  ren, double  displayPos[2], double  worldPos[3], double  worldOrient[9]  )

overridevirtual

Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed.

This method is typically used by the representation to place the point initially. For the Terrain point placer this computes world points that lie at the specified height above the terrain.

Reimplemented from vtkPointPlacer.

ComputeWorldPosition() [2/2]

int vtkTerrainDataPointPlacer::ComputeWorldPosition ( vtkRenderer *  ren, double  displayPos[2], double  refWorldPos[3], double  worldPos[3], double  worldOrient[9]  )

overridevirtual

Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point.

This method is typically used by the representation to move the point.

Reimplemented from vtkPointPlacer.

ValidateWorldPosition() [1/2]

int vtkTerrainDataPointPlacer::ValidateWorldPosition ( double  worldPos[3] )

overridevirtual

Given a world position check the validity of this position according to the constraints of the placer.

Reimplemented from vtkPointPlacer.

ValidateDisplayPosition()

int vtkTerrainDataPointPlacer::ValidateDisplayPosition ( vtkRenderer *  , double  displayPos[2]  )

overridevirtual

Given a display position, check the validity of this position.

Reimplemented from vtkPointPlacer.

ValidateWorldPosition() [2/2]

int vtkTerrainDataPointPlacer::ValidateWorldPosition ( double  worldPos[3], double  worldOrient[9]  )

overridevirtual

Given a world position and a world orientation, validate it according to the constraints of the placer.

Reimplemented from vtkPointPlacer.

GetPropPicker()

virtual vtkPropPicker * vtkTerrainDataPointPlacer::GetPropPicker ( )

virtual

Get the Prop picker.

Member Data Documentation

TerrainProps

vtkPropCollection* vtkTerrainDataPointPlacer::TerrainProps

protected

Definition at line 122 of file vtkTerrainDataPointPlacer.h.

PropPicker

vtkPropPicker* vtkTerrainDataPointPlacer::PropPicker

protected

Definition at line 123 of file vtkTerrainDataPointPlacer.h.

HeightOffset

double vtkTerrainDataPointPlacer::HeightOffset

protected

Definition at line 124 of file vtkTerrainDataPointPlacer.h.

---

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

• Interaction/Widgets/vtkTerrainDataPointPlacer.h