FPlane

Structure for three dimensional planes.

Windows
MacOS
Linux

Inheritance Hierarchy

FVector

FPlane

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Math/Plane.h

Include

#include "Math/Plane.h"

Syntax

struct FPlane : public FVector

Remarks

Structure for three dimensional planes.

Stores the coeffecients as Xx+Yy+Zz=W.

that this is different from many other Plane classes that use Xx+Yy+Zz+W=0.

Variables

Name Description

Public variable

float

 

W

The w-component.

Constructors

Name Description

Public function

FPlane()

Default constructor (no initialization).

FPlane inline functions

Public function

FPlane

(
    const FVector4& V
)

Constructor.

Public function

FPlane

(
    EForceInit
)

Constructor

Public function

FPlane

(
    FVector InNormal,
    float InW
)

Constructor.

Public function

FPlane

(
    FVector InBase,
    const FVector& InNormal
)

Constructor.

Public function

FPlane

(
    FVector A,
    FVector B,
    FVector C
)

Constructor.

Public function

FPlane

(
    float InX,
    float InY,
    float InZ,
    float InW
)

Constructor.

Functions

Name Description

Public function Const

bool

 

Equals

(
    const FPlane& V,
    float Tolerance
)

Checks whether two planes are equal within specified tolerance.

Public function Const

FPlane

 

Flip()

Get a flipped version of the plane.

Public function Const

const FVecto...

 

GetNormal()

Get the normal of this plane.

Public function Const

FVector

 

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

(
    float Tolerance
)

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

Public function Const

float

 

PlaneDot

(
    const FVector& P
)

Calculates distance between plane and a point.

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Public function Const

FPlane

 

TransformBy

(
    const FMatrix& M
)

Get the result of transforming the plane by a Matrix.

Public function Const

FPlane

 

TransformByUsingAdjointT

(
    const FMatrix& M,
    float DetM,
    const FMatrix& TA
)

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

Operators

Name Description

Public function Const

FPlane

 

operator-

(
    const FPlane& V
)

Gets result of subtracting a plane from this.

Public function Const

bool

 

operator!=

(
    const FPlane& V
)

Check if two planes are different.

Public function

FPlane

 

operator*

(
    const FPlane& V
)

Gets result of multiplying a plane with this.

Public function Const

FPlane

 

operator*

(
    float Scale
)

Gets result of scaling a plane.

Public function

FPlane

 

operator*=

(
    const FPlane& V
)

Multiply another plane with this.

Public function

FPlane

 

operator*=

(
    float Scale
)

Scale this plane.

Public function Const

FPlane

 

operator/

(
    float Scale
)

Gets result of dividing a plane.

Public function

FPlane

 

operator/=

(
    float V
)

Divide this plane.

Public function Const

float

 

operator|

(
    const FPlane& V
)

Calculates dot product of two planes.

Public function Const

FPlane

 

operator+

(
    const FPlane& V
)

Gets result of adding a plane to this.

Public function

FPlane

 

operator+=

(
    const FPlane& V
)

Add another plane to this.

Public function

FPlane

 

operator-=

(
    const FPlane& V
)

Subtract another plane from this.

Public function Const

bool

 

operator==

(
    const FPlane& V
)

Check if two planes are identical.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss