TPlane | Unreal Engine 5.7 Documentation | Epic Developer Community


Name	TPlane
Type	struct
Header File	/Engine/Source/Runtime/Core/Public/Math/MathFwd.h
Include Path	#include "Math/MathFwd.h"
Source	/Engine/Source/Runtime/Core/Public/Math/Plane.h

Syntax

template<typename T>  
struct TPlane : public UE::Math::TVector< T >

Name	Remarks	Include Path
TPlane ( TVector< T > A, TVector< T > B, TVector< T > C )	Constructor.	Math/Plane.h
TPlane ()	Default constructor (no initialization).	Math/Plane.h
TPlane ( const TVector4< T >& V )	Constructor.TPlane inline functions	Math/Plane.h
TPlane ( EForceInit )	Constructor	Math/Plane.h
TPlane ( const TPlane< FArg >& From )	Conversion to other type.	Math/Plane.h
TPlane ( TVector< T > InNormal, T InW )	Constructor.	Math/Plane.h
TPlane ( TVector< T > InBase, const TVector< T >& InNormal )	Constructor.	Math/Plane.h
TPlane ( T InX, T InY, T InZ, T InW )	Constructor.	Math/Plane.h

Name	Type	Remarks	Include Path
FReal	T		Math/Plane.h

Name	Type	Remarks	Include Path	Unreal Specifiers
W	T	The w-component.	Math/Plane.h

Name	Remarks	Include Path
void DiagnosticCheckNaN()		Math/Plane.h
bool Equals ( const TPlane< T >& V, T Tolerance ) const	Checks whether two planes are equal within specified tolerance.	Math/Plane.h
TPlane< T > Flip()	Get a flipped version of the plane.	Math/Plane.h
const TVector< T > & GetNormal()	Get the normal of this plane.	Math/Plane.h
TVector< T > GetOrigin()	Get the origin of this plane.	Math/Plane.h
bool IsValid()	Checks if this plane is valid (ie: if it has a non-zero normal).	Math/Plane.h
bool NetSerialize ( FArchive& Ar, UPackageMap*, bool& bOutSuccess )	Serializes the vector compressed for e.g. network transmission.	Math/Plane.h
bool Normalize ( T Tolerance )	Normalize this plane in-place if it is larger than a given tolerance. Leaves it unchanged if not.	Math/Plane.h
T PlaneDot ( const TVector< T >& P ) const	Calculates distance between plane and a point.	Math/Plane.h
bool Serialize ( FArchive& Ar )		Math/Plane.h
bool SerializeFromMismatchedTag ( FName StructTag, FArchive& Ar )		Math/Plane.h
TPlane< T > TransformBy ( const TMatrix< T >& M ) const	Get the result of transforming the plane by a Matrix.	Math/Plane.h
TPlane< T > TransformByUsingAdjointT ( const TMatrix< T >& M, T DetM, const TMatrix< T >& TA ) const	You can optionally pass in the matrices transpose-adjoint, which save it recalculating it.	Math/Plane.h
TPlane< T > TranslateBy ( const TVector< T >& V ) const	Get the result of translating the plane by the given offset	Math/Plane.h

Name	Remarks	Include Path
TPlane< T > operator- ( const TPlane< T >& V ) const	Gets result of subtracting a plane from this.	Math/Plane.h
bool operator!= ( const TPlane< T >& V ) const	Check if two planes are different.	Math/Plane.h
TPlane< T > operator* ( T Scale ) const	Gets result of scaling a plane.	Math/Plane.h
TPlane< T > operator* ( const TPlane< T >& V ) const	Gets result of multiplying a plane with this.	Math/Plane.h
TPlane< T > operator*= ( const TPlane< T >& V )	Multiply another plane with this.	Math/Plane.h
TPlane< T > operator*= ( T Scale )	Scale this plane.	Math/Plane.h
TPlane< T > operator/ ( T Scale ) const	Gets result of dividing a plane.	Math/Plane.h
TPlane< T > operator/= ( T V )	Divide this plane.	Math/Plane.h
T operator\| ( const TPlane< T >& V ) const	Calculates dot product of two planes.	Math/Plane.h
TPlane< T > operator+ ( const TPlane< T >& V ) const	Gets result of adding a plane to this.	Math/Plane.h
TPlane< T > operator+= ( const TPlane< T >& V )	Add another plane to this.	Math/Plane.h
TPlane< T > operator-= ( const TPlane< T >& V )	Subtract another plane from this.	Math/Plane.h
bool operator== ( const TPlane< T >& V ) const	Check if two planes are identical.	Math/Plane.h