FreeMat: vtkTerrainDataPointPlacer

FreeMat

- Main Page
- Related Pages

vtkTerrainDataPointPlacer

Section: Visualization Toolkit Widget Classes

# Usage

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.

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

To create an instance of class vtkTerrainDataPointPlacer, simply invoke its constructor as follows

      obj = vtkTerrainDataPointPlacer

# Methods

The class vtkTerrainDataPointPlacer has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, `obj` is an instance of the vtkTerrainDataPointPlacer class.

- `string = obj.GetClassName ()` - Standard methods for instances of this class.
- `int = obj.IsA (string name)` - Standard methods for instances of this class.
- `vtkTerrainDataPointPlacer = obj.NewInstance ()` - Standard methods for instances of this class.
- `vtkTerrainDataPointPlacer = obj.SafeDownCast (vtkObject o)` - Standard methods for instances of this class.
- `obj.AddProp (vtkProp )`
- `obj.RemoveAllProps ()`
- `obj.SetHeightOffset (double )` - 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.
- `double = obj.GetHeightOffset ()` - 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.
- `int = obj.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. 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.
- `int = obj.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. This method is typically used by the representation to move the point.
- `int = obj.ValidateWorldPosition (double worldPos[3])` - Given a world position check the validity of this position according to the constraints of the placer
- `int = obj.ValidateDisplayPosition (vtkRenderer , double displayPos[2])` - Given a display position, check the validity of this position.
- `int = obj.ValidateWorldPosition (double worldPos[3], double worldOrient[9])` - Given a world position and a world orientation, validate it according to the constraints of the placer.
- `vtkPropPicker = obj.GetPropPicker ()` - Get the Prop picker.