ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkProjectedTerrainPath Class Reference

vtkProjectedTerrainPath - project a polyline onto a terrain More...

Inheritance diagram for Kitware.VTK.vtkProjectedTerrainPath:
[legend]
Collaboration diagram for Kitware.VTK.vtkProjectedTerrainPath:
[legend]

List of all members.

Public Types

enum  HUG_PROJECTION_WrapperEnum { HUG_PROJECTION = 2, NONOCCLUDED_PROJECTION = 1, SIMPLE_PROJECTION = 0 }
 Specify the second input (the terrain) onto which the polyline(s) should be projected. More...

Public Member Functions

 vtkProjectedTerrainPath (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkProjectedTerrainPath ()
 Instantiate the class.
virtual double GetHeightOffset ()
 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.
virtual double GetHeightTolerance ()
 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.
virtual double GetHeightToleranceMaxValue ()
 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.
virtual double GetHeightToleranceMinValue ()
 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.
virtual int GetMaximumNumberOfLines ()
 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.
virtual int GetMaximumNumberOfLinesMaxValue ()
 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.
virtual int GetMaximumNumberOfLinesMinValue ()
 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.
virtual int GetProjectionMode ()
 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).
virtual int GetProjectionModeMaxValue ()
 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).
virtual int GetProjectionModeMinValue ()
 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).
vtkImageData GetSource ()
 Specify the second input (the terrain) onto which the polyline(s) should be projected.
override int IsA (string type)
 Standard methids for printing and determining type information.
new vtkProjectedTerrainPath NewInstance ()
 Standard methids for printing and determining type information.
virtual void SetHeightOffset (double _arg)
 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.
virtual void SetHeightTolerance (double _arg)
 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.
virtual void SetMaximumNumberOfLines (int _arg)
 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.
virtual void SetProjectionMode (int _arg)
 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).
void SetProjectionModeToHug ()
 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).
void SetProjectionModeToNonOccluded ()
 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).
void SetProjectionModeToSimple ()
 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).
void SetSource (vtkImageData source)
 Specify the second input (the terrain) onto which the polyline(s) should be projected.

Static Public Member Functions

static new vtkProjectedTerrainPath New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Standard methids for printing and determining type information.
static new vtkProjectedTerrainPath SafeDownCast (vtkObjectBase o)
 Standard methids for printing and determining type information.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkProjectedTerrainPath"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "23vtkProjectedTerrainPath"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkProjectedTerrainPath_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkProjectedTerrainPath_GetHeightOffset_01 (HandleRef pThis)
static internal double vtkProjectedTerrainPath_GetHeightTolerance_02 (HandleRef pThis)
static internal double vtkProjectedTerrainPath_GetHeightToleranceMaxValue_03 (HandleRef pThis)
static internal double vtkProjectedTerrainPath_GetHeightToleranceMinValue_04 (HandleRef pThis)
static internal int vtkProjectedTerrainPath_GetMaximumNumberOfLines_05 (HandleRef pThis)
static internal int vtkProjectedTerrainPath_GetMaximumNumberOfLinesMaxValue_06 (HandleRef pThis)
static internal int vtkProjectedTerrainPath_GetMaximumNumberOfLinesMinValue_07 (HandleRef pThis)
static internal int vtkProjectedTerrainPath_GetProjectionMode_08 (HandleRef pThis)
static internal int vtkProjectedTerrainPath_GetProjectionModeMaxValue_09 (HandleRef pThis)
static internal int vtkProjectedTerrainPath_GetProjectionModeMinValue_10 (HandleRef pThis)
static internal IntPtr vtkProjectedTerrainPath_GetSource_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkProjectedTerrainPath_IsA_12 (HandleRef pThis, string type)
static internal int vtkProjectedTerrainPath_IsTypeOf_13 (string type)
static internal IntPtr vtkProjectedTerrainPath_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkProjectedTerrainPath_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProjectedTerrainPath_SetHeightOffset_17 (HandleRef pThis, double _arg)
static internal void vtkProjectedTerrainPath_SetHeightTolerance_18 (HandleRef pThis, double _arg)
static internal void vtkProjectedTerrainPath_SetMaximumNumberOfLines_19 (HandleRef pThis, int _arg)
static internal void vtkProjectedTerrainPath_SetProjectionMode_20 (HandleRef pThis, int _arg)
static internal void vtkProjectedTerrainPath_SetProjectionModeToHug_21 (HandleRef pThis)
static internal void vtkProjectedTerrainPath_SetProjectionModeToNonOccluded_22 (HandleRef pThis)
static internal void vtkProjectedTerrainPath_SetProjectionModeToSimple_23 (HandleRef pThis)
static internal void vtkProjectedTerrainPath_SetSource_24 (HandleRef pThis, HandleRef source)

Static Private Member Functions

static vtkProjectedTerrainPath ()
 Automatically generated type registration mechanics.

Detailed Description

vtkProjectedTerrainPath - project a polyline onto a terrain

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

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

vtkGreedyTerrainDecimation


Member Enumeration Documentation

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

Enumerator:
HUG_PROJECTION 

enum member

NONOCCLUDED_PROJECTION 

enum member

SIMPLE_PROJECTION 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Instantiate the class.


Member Function Documentation

override void Kitware.VTK.vtkProjectedTerrainPath.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

Here is the call graph for this function:

override int Kitware.VTK.vtkProjectedTerrainPath.IsA ( string  type) [virtual]

Standard methids for printing and determining type information.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

static new int Kitware.VTK.vtkProjectedTerrainPath.IsTypeOf ( string  type) [static]

Standard methids for printing and determining type information.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Instantiate the class.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Standard methids for printing and determining type information.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Standard methids for printing and determining type information.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkProjectedTerrainPath.SetHeightOffset ( double  _arg) [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.

virtual void Kitware.VTK.vtkProjectedTerrainPath.SetHeightTolerance ( double  _arg) [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.

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.

virtual void Kitware.VTK.vtkProjectedTerrainPath.SetProjectionMode ( int  _arg) [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).

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

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

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

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

static internal double Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_GetHeightOffset_01 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_GetHeightTolerance_02 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_GetSource_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_IsA_12 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_SetHeightOffset_17 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_SetHeightTolerance_18 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_SetMaximumNumberOfLines_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_SetProjectionMode_20 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkProjectedTerrainPath.vtkProjectedTerrainPath_SetSource_24 ( HandleRef  pThis,
HandleRef  source 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkProjectedTerrainPath.MRClassNameKey = "23vtkProjectedTerrainPath" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

new const string Kitware.VTK.vtkProjectedTerrainPath.MRFullTypeName = "Kitware.VTK.vtkProjectedTerrainPath"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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