Information returned from a snap process from SnappingToolHelper. More...

#include <tool_helpers.h>

Collaboration diagram for OpenOrienteering::SnappingToolHelperSnapInfo:

[legend]

Public Attributes
SnappingToolHelper::SnapObjects	type
	Type of object snapped onto. More...

Object *	object
	Object snapped onto, if type is ObjectCorners or ObjectPaths, else nullptr. More...

MapCoordVector::size_type	coord_index
	Index of the map coordinate which was snapped onto if type is ObjectCorners, else -1 (not snapped to a specific coordinate) More...

PathCoord	path_coord
	The closest point on the snapped path is returned in path_coord if type == ObjectPaths. More...

Detailed Description

Information returned from a snap process from SnappingToolHelper.

Member Data Documentation

MapCoordVector::size_type OpenOrienteering::SnappingToolHelperSnapInfo::coord_index

Index of the map coordinate which was snapped onto if type is ObjectCorners, else -1 (not snapped to a specific coordinate)

Object* OpenOrienteering::SnappingToolHelperSnapInfo::object

Object snapped onto, if type is ObjectCorners or ObjectPaths, else nullptr.

PathCoord OpenOrienteering::SnappingToolHelperSnapInfo::path_coord

The closest point on the snapped path is returned in path_coord if type == ObjectPaths.

SnappingToolHelper::SnapObjects OpenOrienteering::SnappingToolHelperSnapInfo::type

Type of object snapped onto.

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