VgMyRouteCreator Class Reference

Interface for Objects responsible for the route creations. More...

Inheritance diagram for VgMyRouteCreator:

List of all members.

Public Types
enum	RoutePoint { eStart, eEnd }
Public Member Functions
virtual bool	setRoutePoint (RoutePoint pPoint, const std::string &pPlaceID)=0
	Sets a RoutePoint to a specific place.
virtual bool	setRoutePoint (RoutePoint pPoint, VgEngine::VgPosition pPosition)=0
	Sets a RoutePoint to a position within the map.
virtual void	resetRoutePoint (RoutePoint pPoint)=0
	Resets the place ID associated with a point.
virtual bool	isRoutePointSet (RoutePoint pPoint)=0
virtual void	computeRoute ()=0
	Computes a route.
virtual VgRoutingModule::VgIRouteRequestParameters *	editRoutingRequestParameters ()=0
	Returns a reference to the routing request parameters that computeRoute uses.
virtual void	resetRoutingRequestParameters ()=0
	Resets the routing request parameters to their initial state.
virtual VgEngine::VgRefPtr < VgEngine::VgAnimationDescriptor >	getRoutePointHighlightAnimationDescriptor ()=0
	Returns the descriptor of an animation intended to emphasize routing points.
virtual void	setAvoidStairs (bool pDisabledFriendly)=0
	Sets up the routing request parameters to include/exclude non disabled-friendly attributes.

---

Detailed Description

Interface for Objects responsible for the route creations.

---

Member Enumeration Documentation

enum VgMyRouteCreator::RoutePoint

Enumerator:

eStart
eEnd

---

Member Function Documentation

virtual void VgMyRouteCreator::computeRoute

(

)

[pure virtual]

Computes a route.

Remarks:

Works only if both end points are set.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual VgRoutingModule::VgIRouteRequestParameters* VgMyRouteCreator::editRoutingRequestParameters

(

)

[pure virtual]

Returns a reference to the routing request parameters that computeRoute uses.

Returns:

a reference to the routing request parameters to be used on the next computeRoute.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual VgEngine::VgRefPtr< VgEngine::VgAnimationDescriptor > VgMyRouteCreator::getRoutePointHighlightAnimationDescriptor

(

)

[pure virtual]

Returns the descriptor of an animation intended to emphasize routing points.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual bool VgMyRouteCreator::isRoutePointSet

(

RoutePoint

pPoint )

[pure virtual]

Parameters:

pPoint

RoutePoint to test.

Returns:

True if the specified point is already set.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual void VgMyRouteCreator::resetRoutePoint

(

RoutePoint

pPoint )

[pure virtual]

Resets the place ID associated with a point.

Parameters:

pPoint

RoutePoint to reset.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual void VgMyRouteCreator::resetRoutingRequestParameters

(

)

[pure virtual]

Resets the routing request parameters to their initial state.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual void VgMyRouteCreator::setAvoidStairs

(

bool

pDisabledFriendly )

[pure virtual]

Sets up the routing request parameters to include/exclude non disabled-friendly attributes.

Parameters:

pDisabledFriendly

True if disabled friendly routing is wanted, false if not

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual bool VgMyRouteCreator::setRoutePoint	(	RoutePoint	pPoint,
		const std::string &	pPlaceID
	)		[pure virtual]

Sets a RoutePoint to a specific place.

Parameters:

pPoint	RoutePoint to set
pPlaceID	Place to associates with pPoint.

Returns:

False if the specified placeID is not routable.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

virtual bool VgMyRouteCreator::setRoutePoint	(	RoutePoint	pPoint,
		VgEngine::VgPosition	pPosition
	)		[pure virtual]

Sets a RoutePoint to a position within the map.

Finds the closest routing node from the routing network to the given position.

• pPosition.getMZOrAltitude() is used to determine what layer the position is associated to.
• Use the method VgMapModule::VgIMapModule::getHeightRangeForLayer() to find the appropriate altitude value for pPosition. For example:

          ...
          double lFloorHeight = 0.0;
  
          float pHeightMax;
          float pHeightMin;
          std::sring lLayerName = "0";
          if ( mMapModule->getHeightRangeForLayer(pLayer, pHeightMax, pHeightMin))
          {
              lFloorHeight = ((pHeightMax + pHeightMin) / 2);
          }
       
          lPosition.mZOrAltitude = lFloorHeight;
          ...
  

  Parameters:

  pPoint	RoutePoint to set
  pPosition	Position to associates with pPoint.

  Returns:

  False if the pPosition is not routable.

Implemented in VgMyBasicApplicationController, and VgMyRoutingHelper.

---

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

• VgMyRouteCreator.h