VgManipulator Class Reference

Public Member Functions
String	getType ()
boolean	getBoundaries (VgPosition pMinimumPosition, VgPosition pMaximumPosition)
boolean	setBoundaries (VgPosition pMinimumPosition, VgPosition pMaximumPosition)
boolean	setBoundaries (VgPositionVector pPositions, boolean pAutoComputeMaxAltitude)
void	setListener (VgManipulatorListenerRefPtr pListener)
void	setAnchor (VgPosition pAnchor)
void	setMinRadius (double pMinRadius)
void	setMaxRadius (double pMaxRadius)

Detailed Description

Controls the way the user interact with the Open GL surface.

Version

2.0.6931

2.1.19 Now includes methods from the removed subclasses Vg2DManipulator, Vg3DManipulator, VgSimpleGestureManipulator and VgSimpleTrackballManipulator.

Member Function Documentation

boolean VgManipulator.getBoundaries	(	VgPosition	pMinimumPosition,
		VgPosition	pMaximumPosition
	)

Retrieves the current boundaries of the camera.

Note

This method is only relevant for the "2D", "3D" and "old2D" manipulators. It is a no-op returning false on other manipulators.

Parameters

pMinimumPosition	Updates with the minimum latitude, longitude, and altitude the camera is allowed to move.
pMaximumPosition	Updates with the maximum latitude, longitude, and altitude the camera is allowed to move

Version

2.1.19 Moved from (removed) VgApplication::Vg2DManipulator to VgApplication::VgManipulator.

Returns

true.

String VgManipulator.getType

(

)

Returns

The type identifier of the instance.

void VgManipulator.setAnchor

(

VgPosition

pAnchor

)

Set the anchor point around with the view will pivot.

Note

This method is only relevant for the "simpleTrackball" manipulator. It is a no-op on other manipulators.

Parameters

pAnchor

position of pivot.

Version

2.1.19 setAnchor was moved from (removed) VgApplication::VgSimpleTrackballManipulator to VgApplication::VgManipulator.

boolean VgManipulator.setBoundaries	(	VgPosition	pMinimumPosition,
		VgPosition	pMaximumPosition
	)

Set the boundaries where the camera can move. If the current camera position is outside this new boundary, the camera will be moved inside this new area.

The original values for the manipulators are set on the vg_config.xml or via the default values of the dataset It is usually smaller than that found on the dataset.

Remarks

you can use this URL https://developers.google.com/maps/documentation/utilities/polylineutility to try out different values

Setting the minimum and maximum altitude (mZOrAltitude) to be the same will still allow some interaction with the manipulator due to the "bounce" effect when one reaches the limits.

Note

This method is only relevant for the "2D", "3D" and "old2D" manipulators. It is a no-op returning false on other manipulators.

Parameters

pMinimumPosition	Minimum latitude, longitude and altitude the camera is allowed to move.
pMaximumPosition	Maximum latitude, longitude and altitude the camera is allowed to move. It supposes the all the values are greater than the values in pMinimumPosition

See also

VgEngine::VgIDatabase::getCurrentDatasetDescriptor

Version

2.1.19 Moved from (removed) VgApplication::Vg2DManipulator to VgApplication::VgManipulator.

Returns

true.

boolean VgManipulator.setBoundaries	(	VgPositionVector	pPositions,
		boolean	pAutoComputeMaxAltitude
	)

Set the boundaries where the camera can move. If the current camera position is outside this new boundary, the camera will be moved inside this new area.

The original values for the manipulators are set on the vg_config.xml or via the default values of the dataset It is usually smaller than that found on the dataset.

Remarks

you can use this URL https://developers.google.com/maps/documentation/utilities/polylineutility to try out different values

Setting the minimum and maximum altitude (mZOrAltitude) to be the same will still allow some interaction with the manipulator due to the "bounce" effect when one reaches the limits.

Note

This method is only relevant for the "2D", "3D" and "old2D" manipulators. It is a no-op returning false on other manipulators.

Parameters

pPositions	Set of positions used to compute the boundaries. Note: the boundaries will be the bounding box of these positions, not the exact polygon described by them.
pAutoComputeMaxAltitude	Pass true to compute the best altitude automatically, using VgICamera::getViewpointFromPositions.

Version

2.1.4

2.1.19 Moved from (removed) VgApplication::Vg2DManipulator to VgApplication::VgManipulator.

void VgManipulator.setListener

(

VgManipulatorListenerRefPtr

pListener

)

Sets the listener to simple gestures. It is notified once a simple gesture is recognized.

Note

This method is only relevant for the "simpleGesture" manipulator. It is a no-op on other manipulators.

Remarks

The listener won't be deleted in ~VgSimpleGestureManipulator(). The caller is responsible of its deletion.

Parameters

pListener

Simple gestures listener. Pass NULL to remove the current Listener.

Version

2.1.19 setListener was moved from (removed) VgApplication::VgSimpleGestureManipulator to VgApplication::VgManipulator.

void VgManipulator.setMaxRadius

(

double

pMaxRadius

)

Set the maximum distance to the anchor point.

Note

This method is only relevant for the "simpleTrackball" manipulator. It is a no-op on other manipulators.

Parameters

pMaxRadius

The maximum radius to set.

Version

2.1.19 setMaxRadius was moved from (removed) VgApplication::VgSimpleTrackballManipulator to VgApplication::VgManipulator.

void VgManipulator.setMinRadius

(

double

pMinRadius

)

Set the minimum distance to the anchor point.

Note

This method is only relevant for the "simpleTrackball" manipulator. It is a no-op on other manipulators.

Parameters

pMinRadius

The minimum radius to set.

Version

2.1.19 setMinRadius was moved from (removed) VgApplication::VgSimpleTrackballManipulator to VgApplication::VgManipulator.

---

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

• VgManipulator.java