FPlane Struct Reference

A plane definition in 3D space. @note The full C++ class is located here: Engine\Source\Runtime\Core\Public\Math\Plane.h. More...

Public Member Functions
Functions
FVector	GetOrigin () const
const FVector &	GetNormal () const
FVector	RayPlaneIntersection (FVector RayOrigin, FVector RayDirection) const
	Find the intersection of a ray and a plane. The ray has a start point with an infinite length. Assumes that theline and plane do indeed intersect; you must make sure they're not parallel before calling.
bool	SegmentPlaneIntersection (FVector StartPoint, FVector EndPoint, FVector &OutIntersectionPoint) const
	Returns true if there is an intersection between the segment specified by StartPoint and Endpoint, andthe plane on which polygon Plane lies. If there is an intersection, the point is placed in out_IntersectionPoint.
FPlane &	opAssign (FPlane Other)
float	PlaneDot (FVector Location) const
Public Member Functions inherited from FVector
FVector	BoundToCube (float Radius) const
FVector	opAdd (FVector Other) const
FVector	opSub (FVector Other) const
FVector	opMul (FVector Other) const
FVector	opDiv (FVector Other) const
FVector	opMul (float Scale) const
FVector	opDiv (float Scale) const
FVector	opNeg () const
FVector	opMulAssign (float Scale)
FVector	opDivAssign (float Scale)
FVector	opMulAssign (FVector Other)
FVector	opDivAssign (FVector Other)
FVector	opAddAssign (FVector Other)
FVector	opSubAssign (FVector Other)
float &	opIndex (int Index)
float	opIndex (int Index) const
bool	opEquals (FVector Other) const
bool	Equals (FVector Other, float Tolerance=KINDA_SMALL_NUMBER) const
FVector	CrossProduct (FVector Other) const
float	DotProduct (FVector Other) const
bool	AllComponentsEqual (float Tolerance=KINDA_SMALL_NUMBER) const
bool	Parallel (FVector Normal2, float ParallelCosineThreshold=THRESH_NORMALS_ARE_PARALLEL) const
	See if two normal vectors are nearly parallel, meaning the angle between them is close to 0 degrees.
bool	Coincident (FVector Normal2, float ParallelCosineThreshold=THRESH_NORMALS_ARE_PARALLEL) const
	See if two normal vectors are coincident (nearly parallel and point in the same direction).
bool	Orthogonal (FVector Normal2, float OrthogonalCosineThreshold=THRESH_NORMALS_ARE_ORTHOGONAL) const
	See if two normal vectors are nearly orthogonal (perpendicular), meaning the angle between them is close to 90 degrees.
float	GetMax () const
float	GetAbsMax () const
float	GetMin () const
float	GetAbsMin () const
FVector	ComponentMin (FVector Other) const
FVector	ComponentMax (FVector Other) const
FVector	ComponentClamp (FVector Min, FVector Max) const
FVector	GetAbs () const
float	Size () const
float	SizeSquared () const
float	Size2D () const
float	SizeSquared2D () const
bool	IsNearlyZero (float Tolerance=KINDA_SMALL_NUMBER) const
bool	IsZero () const
bool	Normalize (float Tolerance=SMALL_NUMBER)
bool	IsNormalized () const
void	ToDirectionAndLength (FVector &OutDir, float &OutLength) const
void	ToDirectionAndLength (FVector &OutDir, float32 &OutLength) const
FVector	GetSignVector () const
FVector	Projection () const
FVector	GetUnsafeNormal () const
FVector	GridSnap (const float &GridSize) const
FVector &	opAssign (FVector Other)
FVector	BoundToBox (FVector Min, FVector Max) const
FVector	GetClampedToSize (float Min, float Max) const
FVector	GetClampedToSize2D (float Min, float Max) const
FVector	GetClampedToMaxSize (float Max) const
FVector	GetClampedToMaxSize2D (float Max) const
void	AddBounded (FVector V, float Radius=MAX_int16)
FVector	Reciprocal () const
bool	IsUniform (float Tolerance=KINDA_SMALL_NUMBER) const
FVector	MirrorByVector (FVector MirrorNormal) const
FVector	VectorPlaneProject (FVector PlaneNormal) const
FVector	RotateAngleAxis (float AngleDeg, FVector Axis) const
FVector	GetSafeNormal (float Tolerance=SMALL_NUMBER, FVector ResultIfZero=FVector ::ZeroVector) const
FVector	GetSafeNormal2D (float Tolerance=SMALL_NUMBER, FVector ResultIfZero=FVector ::ZeroVector) const
float	CosineAngle2D (FVector B) const
FVector	ProjectOnTo (FVector A) const
	Gets a copy of this vector projected onto the input vector.
FVector	ProjectOnToNormal (FVector Normal) const
	Gets a copy of this vector projected onto the input vector, which is assumed to be unit length.
void	FindBestAxisVectors (FVector &Axis1, FVector &Axis2) const
void	UnwindEuler () const
bool	ContainsNaN () const
bool	IsUnit (float LengthSquaredTolerance=KINDA_SMALL_NUMBER) const
float	HeadingAngle () const
bool	PointsAreSame (FVector P2) const
bool	PointsAreNear (FVector P2, float Dist) const
float	Distance (FVector Other) const
float	DistSquared (FVector Other) const
float	Dist2D (FVector Other) const
float	DistXY (FVector Other) const
float	DistSquaredXY (FVector Other) const
float	DistSquared2D (FVector Other) const
FRotator	ToOrientationRotator () const
FQuat	ToOrientationQuat () const
FRotator	Rotation () const
bool	InitFromString (FString SourceString)
FString	ToString () const
float	AngularDistance (FVector B) const
	Get the angle in radians between two vectors. Vectors are not assumed to be normalized.
float	AngularDistanceForNormals (FVector B) const
	Get the angle in radians between two normal vectors. Both vectors are assumed to be unit length, or a wrong value will be returned.
FVector	ConstrainToDirection (FVector Direction) const
FVector	ConstrainToPlane (FVector PlaneUp) const
float	Dist2D (FVector Other, FVector UpDirection) const
float	DistSquared2D (FVector Other, FVector UpDirection) const
FVector	MoveTowards (FVector Target, float StepSize) const
FVector	PointPlaneProject (FVector PlaneBase, FVector PlaneNormal) const
float	Size2D (FVector UpDirection) const
float	SizeSquared2D (FVector UpDirection) const
FString	ToColorString () const

Public Attributes
Plane
float	W
Vector
float	Y
float	Z
float	X
Variables
const FVector	Normal
const FVector	Origin
Public Attributes inherited from FVector
float	Y
float	Z
float	X
const float	Max
const float	AbsMax
const float	Min
const float	AbsMin
const FVector	Abs
const FVector	SignVector
const FVector	UnsafeNormal

Additional Inherited Members
Static Public Attributes inherited from FVector
static const FVector	OneVector
static const FVector	UpVector
static const FVector	DownVector
static const FVector	ForwardVector
static const FVector	BackwardVector
static const FVector	RightVector
static const FVector	LeftVector
static const FVector	ZeroVector

Detailed Description

A plane definition in 3D space. @note The full C++ class is located here: Engine\Source\Runtime\Core\Public\Math\Plane.h.

Member Function Documentation

GetNormal()

const FVector & GetNormal

(

)

const

GetOrigin()

FVector GetOrigin

(

)

const

opAssign()

FPlane & opAssign

(

FPlane

Other

)

PlaneDot()

float PlaneDot

(

FVector

Location

)

const

RayPlaneIntersection()

FVector RayPlaneIntersection	(	FVector	RayOrigin,
		FVector	RayDirection ) const

Find the intersection of a ray and a plane. The ray has a start point with an infinite length. Assumes that theline and plane do indeed intersect; you must make sure they're not parallel before calling.

Parameters

RayOrigin	The start point of the ray
RayDirection	The direction the ray is pointing (normalized vector)

Returns

The point of intersection between the ray and the plane.

SegmentPlaneIntersection()

bool SegmentPlaneIntersection	(	FVector	StartPoint,
		FVector	EndPoint,
		FVector &	OutIntersectionPoint ) const

Returns true if there is an intersection between the segment specified by StartPoint and Endpoint, andthe plane on which polygon Plane lies. If there is an intersection, the point is placed in out_IntersectionPoint.

Parameters

StartPoint	start point of segment
EndPoint	end point of segment
OutIntersectionPoint	the point on the segment that intersects the mesh (if any)

Returns

true if intersection occurred

Member Data Documentation

Normal

const FVector Normal

Origin

const FVector Origin

W

float W

X

float X

Y

float Y

Z

float Z