project a polyline onto a terrain More...

#include <vtkProjectedTerrainPath.h>

Inheritance diagram for vtkProjectedTerrainPath:

Collaboration diagram for vtkProjectedTerrainPath:

Public Types
enum	{ SIMPLE_PROJECTION = 0, NONOCCLUDED_PROJECTION, HUG_PROJECTION }

typedef vtkPolyDataAlgorithm	Superclass
	Standard methods for printing and determining type information. More...

Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

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...

vtkProjectedTerrainPath *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetSourceData (vtkImageData *source)
	Specify the second input (the terrain) onto which the polyline(s) should be projected. More...

vtkImageData *	GetSource ()

void	SetSourceConnection (vtkAlgorithmOutput *algOutput)
	Specify the second input (the terrain) onto which the polyline(s) should be projected. More...

virtual void	SetProjectionMode (int)
	Determine how to control the projection process. More...

virtual int	GetProjectionMode ()

void	SetProjectionModeToSimple ()

void	SetProjectionModeToNonOccluded ()

void	SetProjectionModeToHug ()

virtual void	SetHeightOffset (double)
	This is the height above (or below) the terrain that the projected path should be. More...

virtual double	GetHeightOffset ()

virtual void	SetHeightTolerance (double)
	This is the allowable variation in the altitude of the path with respect to the variation in the terrain. More...

virtual double	GetHeightTolerance ()

virtual void	SetMaximumNumberOfLines (vtkIdType)
	This instance variable can be used to limit the total number of line segments created during subdivision. More...

virtual vtkIdType	GetMaximumNumberOfLines ()

Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const

vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkPolyData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details More...

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Decrease the reference count (release by another object). More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual double	GetProgress ()
	Get the execution progress of a process object. More...

void	SetProgress (double)
	`SetProgress` is deprecated. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressShift ()

virtual double	GetProgressScale ()

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()

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)

vtkCommand *	GetCommand (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)

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkProjectedTerrainPath *	SafeDownCast (vtkObjectBase *o)

static vtkProjectedTerrainPath *	New ()
	Instantiate the class. More...

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

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 ()

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

	vtkProjectedTerrainPath ()

	~vtkProjectedTerrainPath () override

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm. More...

void	GetImageIndex (double x[3], double loc[2], int ij[2])

double	GetHeight (double loc[2], int ij[2])

void	ComputeError (vtkIdType edgeId)

void	RemoveOcclusions ()

void	HugTerrain ()

void	SplitEdge (vtkIdType eId, double t)

Protected Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()

	~vtkPolyDataAlgorithm () override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	ProjectionMode

double	HeightOffset

double	HeightTolerance

vtkIdType	MaximumNumberOfLines

int	Dimensions [3]

int	Extent [6]

double	Origin [3]

double	Spacing [3]

vtkDataArray *	Heights

vtkPoints *	Points

vtkIdType	NumLines

vtkPriorityQueue *	PositiveLineError

vtkPriorityQueue *	NegativeLineError

vtkEdgeList *	EdgeList

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

unsigned long	ErrorCode

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

project a polyline onto a terrain

vtkProjectedTerrainPath projects an input polyline onto a terrain. (The terrain is defined by a 2D height image and is the second input to the filter.) The polyline projection is controlled via several modes as follows. 1) Simple mode projects the polyline points onto the terrain, taking into account the height offset instance variable. 2) Non-occluded mode insures that no parts of the polyline are occluded by the terrain (e.g. a line passes through a mountain). This may require recursive subdivision of the polyline. 3) Hug mode insures that the polyine points remain within a constant distance from the surface. This may also require recursive subdivision of the polyline. Note that both non-occluded mode and hug mode also take into account the height offset, so it is possible to create paths that hug terrain a certain distance above it. To use this filter, define two inputs: 1) a polyline, and 2) an image whose scalar values represent a height field. Then specify the mode, and the height offset to use.

An description of the algorithm is as follows. The filter begins by projecting the polyline points to the image (offset by the specified height offset). If the mode is non-occluded or hug, then the maximum error along each line segment is computed and placed into a priority queue. Each line segment is then split at the point of maximum error, and the two new line segments are evaluated for maximum error. This process continues until the line is not occluded by the terrain (non-occluded mode) or satisfies the error on variation from the surface (hug mode). (Note this process is repeated for each polyline in the input. Also, the maximum error is computed in two parts: a maximum positive error and maximum negative error. If the polyline is above the terrain–i.e., the height offset is positive–in non-occluded or hug mode all negative errors are eliminated. If the polyline is below the terrain–i.e., the height offset is negative–in non-occluded or hug mode all positive errors are eliminated.)

Warning: This algorithm requires the entire input image to be in memory, hence it may not work for extremely large images.; The input height image is assumed to be positioned in the x-y plane so the scalar value is the z-coordinate, height value.; A priority queue is used so that the 1) the total number of line segments can be controlled, and 2) the algorithm can terminate when the errors in the queue are less than the specified error tolerance.

See also: vtkGreedyTerrainDecimation

Definition at line 79 of file vtkProjectedTerrainPath.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkProjectedTerrainPath::Superclass

Standard methods for printing and determining type information.

Definition at line 86 of file vtkProjectedTerrainPath.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SIMPLE_PROJECTION
NONOCCLUDED_PROJECTION
HUG_PROJECTION

Definition at line 112 of file vtkProjectedTerrainPath.h.

Constructor & Destructor Documentation

◆ vtkProjectedTerrainPath()

vtkProjectedTerrainPath::vtkProjectedTerrainPath ( )

protected

◆ ~vtkProjectedTerrainPath()

vtkProjectedTerrainPath::~vtkProjectedTerrainPath ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkProjectedTerrainPath::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 vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkProjectedTerrainPath::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkProjectedTerrainPath* vtkProjectedTerrainPath::NewInstance ( ) const

◆ PrintSelf()

void vtkProjectedTerrainPath::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 vtkPolyDataAlgorithm.

◆ New()

static vtkProjectedTerrainPath* vtkProjectedTerrainPath::New ( )

static

Instantiate the class.

◆ SetSourceData()

void vtkProjectedTerrainPath::SetSourceData ( vtkImageData * source )

Specify the second input (the terrain) onto which the polyline(s) should be projected.

Note: This assigns a data object as the input terrain. To establish a pipeline connection, use SetSourceConnection() method.

◆ GetSource()

vtkImageData* vtkProjectedTerrainPath::GetSource ( )

◆ SetSourceConnection()

void vtkProjectedTerrainPath::SetSourceConnection ( vtkAlgorithmOutput * algOutput )

Specify the second input (the terrain) onto which the polyline(s) should be projected.

Note: vtkImageData* is required

◆ SetProjectionMode()

virtual void vtkProjectedTerrainPath::SetProjectionMode ( int )

virtual

Determine how to control the projection process.

Simple projection just projects the original polyline points. Non-occluded projection insures that the polyline does not intersect the terrain surface. Hug projection is similar to non-occulded projection except that produces a path that is nearly parallel to the terrain (within the user specified height tolerance).

◆ GetProjectionMode()

virtual int vtkProjectedTerrainPath::GetProjectionMode ( )

virtual

◆ SetProjectionModeToSimple()

void vtkProjectedTerrainPath::SetProjectionModeToSimple ( )

inline

Definition at line 130 of file vtkProjectedTerrainPath.h.

◆ SetProjectionModeToNonOccluded()

void vtkProjectedTerrainPath::SetProjectionModeToNonOccluded ( )

inline

Definition at line 131 of file vtkProjectedTerrainPath.h.

◆ SetProjectionModeToHug()

void vtkProjectedTerrainPath::SetProjectionModeToHug ( )

inline

Definition at line 132 of file vtkProjectedTerrainPath.h.

◆ SetHeightOffset()

virtual void vtkProjectedTerrainPath::SetHeightOffset ( double )

virtual

This is the height above (or below) the terrain that the projected path should be.

Positive values indicate distances above the terrain; negative values indicate distances below the terrain.

◆ GetHeightOffset()

virtual double vtkProjectedTerrainPath::GetHeightOffset ( )

virtual

◆ SetHeightTolerance()

virtual void vtkProjectedTerrainPath::SetHeightTolerance ( double )

virtual

This is the allowable variation in the altitude of the path with respect to the variation in the terrain.

It only comes into play if the hug projection mode is enabled.

◆ GetHeightTolerance()

virtual double vtkProjectedTerrainPath::GetHeightTolerance ( )

virtual

◆ SetMaximumNumberOfLines()

virtual void vtkProjectedTerrainPath::SetMaximumNumberOfLines ( vtkIdType )

virtual

This instance variable can be used to limit the total number of line segments created during subdivision.

Note that the number of input line segments will be the minimum number that cab be output.

◆ GetMaximumNumberOfLines()

virtual vtkIdType vtkProjectedTerrainPath::GetMaximumNumberOfLines ( )

virtual

◆ RequestData()

int vtkProjectedTerrainPath::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ FillInputPortInformation()

int vtkProjectedTerrainPath::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

◆ GetImageIndex()

void vtkProjectedTerrainPath::GetImageIndex	(	double	x[3],
		double	loc[2],
		int	ij[2]
	)

protected

◆ GetHeight()

double vtkProjectedTerrainPath::GetHeight	(	double	loc[2],
		int	ij[2]
	)

protected

◆ ComputeError()

void vtkProjectedTerrainPath::ComputeError ( vtkIdType edgeId )

protected

◆ RemoveOcclusions()

void vtkProjectedTerrainPath::RemoveOcclusions ( )

protected

◆ HugTerrain()

void vtkProjectedTerrainPath::HugTerrain ( )

protected

◆ SplitEdge()

void vtkProjectedTerrainPath::SplitEdge	(	vtkIdType	eId,
		double	t
	)

protected

Member Data Documentation

◆ ProjectionMode

int vtkProjectedTerrainPath::ProjectionMode

protected

Definition at line 181 of file vtkProjectedTerrainPath.h.

◆ HeightOffset

double vtkProjectedTerrainPath::HeightOffset

protected

Definition at line 182 of file vtkProjectedTerrainPath.h.

◆ HeightTolerance

double vtkProjectedTerrainPath::HeightTolerance

protected

Definition at line 183 of file vtkProjectedTerrainPath.h.

◆ MaximumNumberOfLines

vtkIdType vtkProjectedTerrainPath::MaximumNumberOfLines

protected

Definition at line 184 of file vtkProjectedTerrainPath.h.

◆ Dimensions

int vtkProjectedTerrainPath::Dimensions[3]

protected

Definition at line 187 of file vtkProjectedTerrainPath.h.

◆ Extent

int vtkProjectedTerrainPath::Extent[6]

protected

Definition at line 188 of file vtkProjectedTerrainPath.h.

◆ Origin

double vtkProjectedTerrainPath::Origin[3]

protected

Definition at line 189 of file vtkProjectedTerrainPath.h.

◆ Spacing

double vtkProjectedTerrainPath::Spacing[3]

protected

Definition at line 190 of file vtkProjectedTerrainPath.h.

◆ Heights

vtkDataArray* vtkProjectedTerrainPath::Heights

protected

Definition at line 191 of file vtkProjectedTerrainPath.h.

◆ Points

vtkPoints* vtkProjectedTerrainPath::Points

protected

Definition at line 192 of file vtkProjectedTerrainPath.h.

◆ NumLines

vtkIdType vtkProjectedTerrainPath::NumLines

protected

Definition at line 193 of file vtkProjectedTerrainPath.h.

◆ PositiveLineError

vtkPriorityQueue* vtkProjectedTerrainPath::PositiveLineError

protected

Definition at line 197 of file vtkProjectedTerrainPath.h.

◆ NegativeLineError

vtkPriorityQueue* vtkProjectedTerrainPath::NegativeLineError

protected

Definition at line 198 of file vtkProjectedTerrainPath.h.

◆ EdgeList

vtkEdgeList* vtkProjectedTerrainPath::EdgeList

protected

Definition at line 201 of file vtkProjectedTerrainPath.h.

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

dox/Filters/Hybrid/vtkProjectedTerrainPath.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkProjectedTerrainPath()

◆ ~vtkProjectedTerrainPath()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetSourceData()

◆ GetSource()

◆ SetSourceConnection()

◆ SetProjectionMode()

◆ GetProjectionMode()

◆ SetProjectionModeToSimple()

◆ SetProjectionModeToNonOccluded()

◆ SetProjectionModeToHug()

◆ SetHeightOffset()

◆ GetHeightOffset()

◆ SetHeightTolerance()

◆ GetHeightTolerance()

◆ SetMaximumNumberOfLines()

◆ GetMaximumNumberOfLines()

◆ RequestData()

◆ FillInputPortInformation()

◆ GetImageIndex()

◆ GetHeight()

◆ ComputeError()

◆ RemoveOcclusions()

◆ HugTerrain()

◆ SplitEdge()

Member Data Documentation

◆ ProjectionMode

◆ HeightOffset

◆ HeightTolerance

◆ MaximumNumberOfLines

◆ Dimensions

◆ Extent

◆ Origin

◆ Spacing

◆ Heights

◆ Points

◆ NumLines

◆ PositiveLineError

◆ NegativeLineError

◆ EdgeList