ConvexVolume.cpp File Reference

#include "ConvexVolume.h"
#include "PrimitiveDrawingUtils.h"
#include "Engine/Polys.h"

Functions
void	GetViewFrustumBoundsInternal (FConvexVolume &OutResult, const FMatrix &ViewProjectionMatrix, bool bUseNearPlane, bool bUseFarPlane, const FPlane *InFarPlaneOverride)
void	GetViewFrustumBounds (FConvexVolume &OutResult, const FMatrix &ViewProjectionMatrix, bool bUseNearPlane)
void	GetViewFrustumBounds (FConvexVolume &OutResult, const FMatrix &ViewProjectionMatrix, bool bUseNearPlane, bool bUseFarPlane)
void	GetViewFrustumBounds (FConvexVolume &OutResult, const FMatrix &ViewProjectionMatrix, const FPlane &InFarPlane, bool bOverrideFarPlane, bool bUseNearPlane)
FArchive &	operator<< (FArchive &Ar, FConvexVolume &ConvexVolume)
void	DrawFrustumWireframe (FPrimitiveDrawInterface *PDI, const FMatrix &FrustumToWorld, FColor Color, uint8 DepthPriority)

Function Documentation

DrawFrustumWireframe()

void DrawFrustumWireframe	(	FPrimitiveDrawInterface *	PDI,
		const FMatrix &	WorldToFrustum,
		FColor	Color,
		uint8	DepthPriority
	)

Draws a wireframe of the bounds of a frustum as defined by a transform from clip-space into world-space.

Parameters

PDI	- The interface to draw the wireframe.
FrustumToWorld	- A transform from clip-space to world-space that defines the frustum.
Color	- The color to draw the wireframe with.
DepthPriority	- The depth priority group to draw the wireframe with.

GetViewFrustumBounds() [1/3]

void GetViewFrustumBounds	(	FConvexVolume &	OutResult,
		const FMatrix &	ViewProjectionMatrix,
		bool	bUseNearPlane
	)

Creates a convex volume bounding the view frustum for a view-projection matrix.

Parameters

[out]	The	FConvexVolume which contains the view frustum bounds.
	ViewProjectionMatrix	- The view-projection matrix which defines the view frustum.
	bUseNearPlane	- True if the convex volume should be bounded by the view frustum's near clipping plane.

GetViewFrustumBounds() [2/3]

void GetViewFrustumBounds	(	FConvexVolume &	OutResult,
		const FMatrix &	ViewProjectionMatrix,
		bool	bUseNearPlane,
		bool	bUseFarPlane
	)

Creates a convex volume bounding the view frustum for a view-projection matrix.

Parameters

[out]	The	FConvexVolume which contains the view frustum bounds.
	ViewProjectionMatrix	- The view-projection matrix which defines the view frustum.
	bUseNearPlane	- True if the convex volume should be bounded by the view frustum's near clipping plane.
	bUseNearPlane	- True if the convex volume should be bounded by the view frustum's far clipping plane.

GetViewFrustumBounds() [3/3]

void GetViewFrustumBounds	(	FConvexVolume &	OutResult,
		const FMatrix &	ViewProjectionMatrix,
		const FPlane &	InFarPlane,
		bool	bOverrideFarPlane,
		bool	bUseNearPlane
	)

Creates a convex volume bounding the view frustum for a view-projection matrix, with an optional far plane override.

Parameters

[out]	The	FConvexVolume which contains the view frustum bounds.
	ViewProjectionMatrix	- The view-projection matrix which defines the view frustum.
	InFarPlane	- Plane to use if bOverrideFarPlane is true.
	bOverrideFarPlane	- Whether to override the far plane.
	bUseNearPlane	- True if the convex volume should be bounded by the view frustum's near clipping plane.

GetViewFrustumBoundsInternal()

void GetViewFrustumBoundsInternal	(	FConvexVolume &	OutResult,
		const FMatrix &	ViewProjectionMatrix,
		bool	bUseNearPlane,
		bool	bUseFarPlane,
		const FPlane *	InFarPlaneOverride
	)

operator<<()

FArchive & operator<<	(	FArchive &	Ar,
		FConvexVolume &	ConvexVolume
	)

Serializor

Parameters

Ar	Archive to serialize data to
ConvexVolume	Convex volumes to serialize to archive

Returns

passed in archive