Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::Graphics::Procedural::PathCoordinate Struct Reference

A convenience class for tracking points in a MultiPath. More...

#include <multipath.h>

Public Member Functions

 PathCoordinate ()
 Blank constructor.
 
 PathCoordinate (const Whole Path, const Whole Point)
 Descriptive constructor. More...
 
 ~PathCoordinate ()
 Class destructor.
 
Boole operator< (const PathCoordinate &Other) const
 Less-than comparison operator. More...
 

Public Attributes

Whole PathIndex
 The index of the path where this coordinate is located.
 
Whole PointIndex
 The index of the point in the path where this coordinate is located.
 

Detailed Description

A convenience class for tracking points in a MultiPath.

Definition at line 83 of file multipath.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::Procedural::PathCoordinate::PathCoordinate ( const Whole  Path,
const Whole  Point 
)

Descriptive constructor.

Parameters
PathThe index of the path where this coordinate is located.
PointThe index of the point in the path where this coordinate is located.

Definition at line 87 of file multipath.cpp.

Member Function Documentation

Boole Mezzanine::Graphics::Procedural::PathCoordinate::operator< ( const PathCoordinate Other) const

Less-than comparison operator.

Parameters
OtherThe other PathCoordinate to compare against.
Returns
Returns true if this PathCoordinate is considered less than the other PathCoordinate, false otherwise.

Definition at line 98 of file multipath.cpp.


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