TPlane

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TVector

TPlane

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/CoreFwd.h

Include

#include "CoreFwd.h"

Syntax

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

Variables

Name Description

Public variable

T

 

W

The w-component.

Constructors

Name Description

Public function

TPlane()

Default constructor (no initialization).

TPlane inline functions

Public function

TPlane

(
    const TVector4< T >& V
)

Constructor.

Public function

TPlane

(
    EForceInit
)

Constructor

Public function

TPlane

(
    const TPlane< FArg >& From
)

Conversion to other type. TODO: explicit!

Public function

TPlane

(
    TVector< T > InNormal,
    T InW
)

Constructor.

Public function

TPlane

(
    TVector< T > InBase,
    const TVector< T >& InNormal
)

Constructor.

Public function

TPlane

(
    TVector< T > A,
    TVector< T > B,
    TVector< T > C
)

Constructor.

Public function

TPlane

(
    T InX,
    T InY,
    T InZ,
    T InW
)

Constructor.

Functions

Name Description

Public function Const

void

 

DiagnosticCheckNaN()

Public function Const

bool

 

Equals

(
    const TPlane< T >& V,
    T Tolerance
)

Checks whether two planes are equal within specified tolerance.

Public function Const

TPlane< T >

 

Flip()

Get a flipped version of the plane.

Public function Const

const TVecto...

 

GetNormal()

Get the normal of this plane.

Public function Const

TVector< T >

 

GetOrigin()

Get the origin of this plane.

Public function Const

bool

 

IsValid()

Checks if this plane is valid (ie: if it has a non-zero normal).

Public function

bool

 

NetSerialize

(
    FArchive& Ar,
    UPackageMap*,
    bool& bOutSuccess
)

Serializes the vector compressed for e.g. network transmission.

Public function

bool

 

Normalize

(
    T Tolerance
)

Normalize this plane in-place if it is larger than a given tolerance. Leaves it unchanged if not.

Public function Const

T

 

PlaneDot

(
    const TVector< T >& P
)

Calculates distance between plane and a point.

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Public function

bool

 

SerializeFromMismatchedTag

(
    FName StructTag,
    FArchive& Ar
)

Public function Const

TPlane< T >

 

TransformBy

(
    const TMatrix< T >& M
)

Get the result of transforming the plane by a Matrix.

Public function Const

TPlane< T >

 

TransformByUsingAdjointT

(
    const TMatrix< T >& M,
    T DetM,
    const TMatrix< T >& TA
)

You can optionally pass in the matrices transpose-adjoint, which save it recalculating it.

Operators

Name Description

Public function Const

TPlane< T >

 

operator-

(
    const TPlane< T >& V
)

Gets result of subtracting a plane from this.

Public function Const

bool

 

operator!=

(
    const TPlane< T >& V
)

Check if two planes are different.

Public function

TPlane< T >

 

operator*

(
    const TPlane< T >& V
)

Gets result of multiplying a plane with this.

Public function Const

TPlane< T >

 

operator*

(
    T Scale
)

Gets result of scaling a plane.

Public function

TPlane< T >

 

operator*=

(
    const TPlane< T >& V
)

Multiply another plane with this.

Public function

TPlane< T >

 

operator*=

(
    T Scale
)

Scale this plane.

Public function Const

TPlane< T >

 

operator/

(
    T Scale
)

Gets result of dividing a plane.

Public function

TPlane< T >

 

operator/=

(
    T V
)

Divide this plane.

Public function Const

T

 

operator|

(
    const TPlane< T >& V
)

Calculates dot product of two planes.

Public function Const

TPlane< T >

 

operator+

(
    const TPlane< T >& V
)

Gets result of adding a plane to this.

Public function

TPlane< T >

 

operator+=

(
    const TPlane< T >& V
)

Add another plane to this.

Public function

TPlane< T >

 

operator-=

(
    const TPlane< T >& V
)

Subtract another plane from this.

Public function Const

bool

 

operator==

(
    const TPlane< T >& V
)

Check if two planes are identical.

Typedefs

Name

Description

FReal