Public Member Functions

 CameraPoint (CameraPoint cp)
 
 CameraPoint (Point p)
 
 CameraPoint (WindowKey in_window, ObjectPoint in_point)
 
 CameraPoint (WindowKey in_window, WorldPoint in_point)
 
 CameraPoint (WindowKey in_window, CameraPoint in_point)
 
 CameraPoint (WindowKey in_window, InnerWindowPoint in_point)
 
 CameraPoint (WindowKey in_window, InnerPixelPoint in_point)
 
 CameraPoint (WindowKey in_window, WindowPoint in_point)
 
 CameraPoint (WindowKey in_window, PixelPoint in_point)
 
 CameraPoint (float in_x, float in_y, float in_z)
 
 CameraPoint (float in_x, float in_y)
 
 CameraPoint (float in_x)
 
override bool Equals (object obj)
 
bool Equals (Vector p)
 
bool Equals (CameraPoint p)
 
override int GetHashCode ()
 

Static Public Member Functions

static implicit operator Point (CameraPoint p)
 
static bool operator!= (CameraPoint p1, CameraPoint p2)
 
static bool operator== (CameraPoint p1, CameraPoint p2)
 

Public Attributes

float x
 
float y
 
float z
 

Detailed Description

The CameraPoint class is a basic 3D point that is assumed to represent a location in camera space.

Constructor & Destructor Documentation

◆ CameraPoint() [1/12]

HPS.CameraPoint.CameraPoint ( CameraPoint  cp)
inline

Initializes a new Point from CameraPoint cp.

Parameters
cpThe CameraPoint to initialize this object from.

◆ CameraPoint() [2/12]

HPS.CameraPoint.CameraPoint ( Point  p)
inline

Copies the existing point p.

◆ CameraPoint() [3/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
ObjectPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [4/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
WorldPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [5/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
CameraPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [6/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
InnerWindowPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [7/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
InnerPixelPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [8/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
WindowPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [9/12]

HPS.CameraPoint.CameraPoint ( WindowKey  in_window,
PixelPoint  in_point 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [10/12]

HPS.CameraPoint.CameraPoint ( float  in_x,
float  in_y,
float  in_z 
)
inline

Converts the point in_point to camera space via in_window.

◆ CameraPoint() [11/12]

HPS.CameraPoint.CameraPoint ( float  in_x,
float  in_y 
)
inline

Initializes a new CameraPoint with x and y parameters and sets the z value to zero.

Parameters
in_xThe x parameter.
in_yThe y parameter.

◆ CameraPoint() [12/12]

HPS.CameraPoint.CameraPoint ( float  in_x)
inline

Initializes a new CameraPoint with the x parameter and sets the y and z value to zero.

Parameters
in_xThe x parameter.

Member Function Documentation

◆ Equals() [1/3]

override bool HPS.CameraPoint.Equals ( object  obj)
inline

Compares this CameraPoint object to another object.

Parameters
objThe object to compare to this object.
Returns
Returns true if the parameter is equivalent, false otherwise.

◆ Equals() [2/3]

bool HPS.CameraPoint.Equals ( Vector  p)
inline

Compares a Vector whose points (x, y, z) correspond to the points of this CameraPoint's (x, y, z).

Parameters
pThe Vector to compare to this object.
Returns
Returns true if the Vector's components are equivalent to this CameraPoint object, false otherwise.

◆ Equals() [3/3]

bool HPS.CameraPoint.Equals ( CameraPoint  p)
inline

Compares a CameraPoint object to this CameraPoint.

Parameters
pThe object to compare to this object.
Returns
Returns true if the parameter is equivalent to this CameraPoint object, false otherwise.

◆ operator Point()

static implicit HPS.CameraPoint.operator Point ( CameraPoint  p)
inlinestatic

Provides an implicit casting operator from CameraPoint to Point.

◆ operator!=()

static bool HPS.CameraPoint.operator!= ( CameraPoint  p1,
CameraPoint  p2 
)
inlinestatic

Compares two CameraPoint objects.

Parameters
p1The first object to compare.
p2The second object to compare.
Returns
Returns true if the two parameters are not equivalent, false otherwise.

◆ operator==()

static bool HPS.CameraPoint.operator== ( CameraPoint  p1,
CameraPoint  p2 
)
inlinestatic

Compares two CameraPoint objects.

Parameters
p1The first object to compare.
p2The second object to compare.
Returns
Returns true if the two parameters are equivalent, false otherwise.

The documentation for this struct was generated from the following file:
  • internals/hps_core/source/cs/HPS.CameraPoint.cs