Photon Quantum 3.0.0

Public Member Functions | Public Attributes | List of all members
Photon.Deterministic.Plane Struct Reference

Represents a plane in three-dimensional space. More...

Public Member Functions

 Plane (FPVector3 origin, FPVector3 normal)
 Represents a plane in three-dimensional space defined by an origin point and a normal vector. More...
 
 Plane (FPVector3 p1, FPVector3 p2, FPVector3 p3)
 Creates a plane in three-dimensional space. More...
 
Boolean IsFrontFacingTo (FPVector3 direction)
 Determines whether the plane is front-facing to a given direction. More...
 
FP SignedDistanceTo (FPVector3 point)
 Returns the signed distance from a point to the plane. More...
 

Public Attributes

FP equation0
 Represents the coefficient for a plane. More...
 
FP equation1
 Represents the coefficient for a plane. More...
 
FP equation2
 Represents the coefficient for a plane. More...
 
FP equation3
 Represents the equation coefficient for a plane. More...
 
FPVector3 normal
 Represents a normal vector in three-dimensional space. More...
 
FPVector3 origin
 Represents the origin point of a plane in three-dimensional space. More...
 

Detailed Description

Represents a plane in three-dimensional space.

A plane is defined by an origin point and a normal vector, which is perpendicular to the plane. The equation of the plane is represented as a mathematical equation: Ax + By + Cz + D = 0, where A, B, C, and D are coefficients that define the plane.

Constructor & Destructor Documentation

◆ Plane() [1/2]

Photon.Deterministic.Plane.Plane ( FPVector3  origin,
FPVector3  normal 
)
inline

Represents a plane in three-dimensional space defined by an origin point and a normal vector.

A plane is typically defined by a point on the plane and a normal vector perpendicular to the plane. The equation of the plane is given by: equation0 * x + equation1 * y + equation2 * z + equation3 = 0

◆ Plane() [2/2]

Photon.Deterministic.Plane.Plane ( FPVector3  p1,
FPVector3  p2,
FPVector3  p3 
)
inline

Creates a plane in three-dimensional space.

Member Function Documentation

◆ IsFrontFacingTo()

Boolean Photon.Deterministic.Plane.IsFrontFacingTo ( FPVector3  direction)
inline

Determines whether the plane is front-facing to a given direction.

Parameters
directionThe direction to compare the plane's normal vector to.
Returns
true if the plane is front-facing to the direction, false otherwise.

◆ SignedDistanceTo()

FP Photon.Deterministic.Plane.SignedDistanceTo ( FPVector3  point)
inline

Returns the signed distance from a point to the plane.

Parameters
pointThe point from which to calculate the distance.
Returns
The signed distance from the point to the plane.

Member Data Documentation

◆ equation0

FP Photon.Deterministic.Plane.equation0

Represents the coefficient for a plane.

◆ equation1

FP Photon.Deterministic.Plane.equation1

Represents the coefficient for a plane.

◆ equation2

FP Photon.Deterministic.Plane.equation2

Represents the coefficient for a plane.

◆ equation3

FP Photon.Deterministic.Plane.equation3

Represents the equation coefficient for a plane.

◆ origin

FPVector3 Photon.Deterministic.Plane.origin

Represents the origin point of a plane in three-dimensional space.

The origin point is the starting point or reference point for the plane. It is used to define the position of the plane in space.

◆ normal

FPVector3 Photon.Deterministic.Plane.normal

Represents a normal vector in three-dimensional space.

A normal vector is a vector that is perpendicular to a plane. In the context of the Plane struct, the normal vector represents the direction that the plane faces.