Public Member Functions | Public Attributes | List of all members
HPoint Class Reference

The HPoint class is the data type of a three-dimensional point. More...

#include <HGlobals.h>

Public Member Functions

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)
 
HPoint & operator= (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)
 

Public Attributes

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 HPoint class is the data type of a three-dimensional point.

The HPoint class encapsulates the x, y, and z coordinates of a 3-dimensional point. HPoint simplifies the passing of 3-dimensional point data to all of the MVO and derived classes. It is widely used by public and internal functions as well as by native HOOPS routines.

Constructor & Destructor Documentation

◆ HPoint() [1/4]

HPoint::HPoint ( )
inline

The default constructor.

◆ HPoint() [2/4]

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

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

◆ HPoint() [3/4]

HPoint::HPoint ( HPoint const *  p)
inline

This constructor accepts a pointer to an HPoint object.

◆ HPoint() [4/4]

HPoint::HPoint ( HPoint const &  p)
inline

This constructor accepts an HPoint reference.

Member Function Documentation

◆ Add()

void HPoint::Add ( float  X,
float  Y,
float  Z = 0.0 
)
inline

This method increases/decreases the coordinate values of an existing HPoint object.

Parameters
XThe amount in which you want to increment or decrement the x coordinate.
YThe amount in which you want to increment or decrement the y coordinate.
ZThe amount in which you want to increment or decrement the z coordinate.

◆ Equal() [1/2]

bool HPoint::Equal ( HPoint const *  p,
float  epsi = HPOINT_EPSILON 
) const
inline

This method checks if the xyz components of the point are equal.

References x, y, and z.

◆ Equal() [2/2]

bool HPoint::Equal ( HPoint const &  p,
float  epsi = HPOINT_EPSILON 
) const
inline

This method checks if the xyz components of the point are equal.

◆ Set() [1/5]

void HPoint::Set ( float  X,
float  Y,
float  Z = 0.0f 
)
inline

This method packs an HPoint object with coordinate values.

Referenced by HPlane::CalculateNormal(), and HMarkupManager::GetMarkupColor().

◆ Set() [2/5]

void HPoint::Set ( HPoint *  p)
inline

This method packs an HPoint object with coordinate values from a given HPoint.

References x, y, and z.

◆ Set() [3/5]

void HPoint::Set ( HPoint const *  p)
inline

This method packs an HPoint object with coordinate values from a given HPoint.

References x, y, and z.

◆ Set() [4/5]

void HPoint::Set ( HPoint &  p)
inline

This method packs an HPoint object with coordinate values from a given HPoint that is passed by reference.

References x, y, and z.

◆ Set() [5/5]

void HPoint::Set ( const HPoint &  p)
inline

This method packs an HPoint object with coordinate values from a given HPoint that is passed by reference.

References x, y, and z.

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