HPointKey Class Reference

#include <HGlobals.h>

Public Member Functions

 HPointKey ()
 
 HPointKey (float X, float Y, float Z=0.0f)
 
 HPointKey (HPoint const *p)
 
 HPointKey (HPoint const &p)
 
bool operator< (HPointKey const &rhs) const
 
bool operator<= (HPointKey const &rhs) const
 
bool operator> (HPointKey const &rhs) const
 
bool operator>= (HPointKey const &rhs) const
 
- Public Member Functions inherited from HPoint
void Add (float X, float Y, float Z=0.0)
 
bool Equal (HPoint const *p, float epsi=HPOINT_EPSILON) const
 
bool Equal (HPoint const &p, float epsi=HPOINT_EPSILON) const
 
 HPoint ()
 
 HPoint (float X, float Y, float Z=0.0f)
 
 HPoint (HPoint const *p)
 
 HPoint (HPoint const &p)
 
bool operator!= (HPoint const &rhs) const
 
HPoint const operator* (float const rhs) const
 
HPoint const & operator*= (float const rhs)
 
HPoint const operator+ (const HPoint &p2) const
 
HPoint const & operator+= (HPoint const &rhs)
 
HPoint const operator- (const HPoint &p2) const
 
HPoint const & operator-= (HPoint const &rhs)
 
HPoint const operator/ (float const rhs) const
 
HPoint const & operator/= (float const rhs)
 
HPointoperator= (const HPoint &)=default
 
bool operator== (HPoint const &rhs) const
 
void Set (float X, float Y, float Z=0.0f)
 
void Set (HPoint *p)
 
void Set (HPoint const *p)
 
void Set (HPoint &p)
 
void Set (const HPoint &p)
 

Additional Inherited Members

- Public Attributes inherited from HPoint
float x
 The x-coordinate of a 3-dimensional point.
 
float y
 The y-coordinate of a 3-dimensional point.
 
float z
 The z-coordinate of a 3-dimensional point.
 

Detailed Description

The HPointKey class is the data type of a three-dimensional point with compairison operators defined so the point can be used as a key in a container class (e.g. the STL).

The HPointKey class encapsulates HPoint. HPointKey can be used as a key in STL containers.

Constructor & Destructor Documentation

◆ HPointKey() [1/4]

HPointKey::HPointKey ( )
inline

The default constructor.

◆ HPointKey() [2/4]

HPointKey::HPointKey ( float  X,
float  Y,
float  Z = 0.0f 
)
inline

This constructor accepts floats for the x, y and z coordinates.

◆ HPointKey() [3/4]

HPointKey::HPointKey ( HPoint const *  p)
inline

This constructor accepts a pointer to an HPoint object.

◆ HPointKey() [4/4]

HPointKey::HPointKey ( HPoint const &  p)
inline

This constructor accepts an HPoint reference.


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