Navigation
API > API/Runtime > API/Runtime/Engine
Utility component for drawing a view frustum. Origin is at the component location, frustum points down position X axis.
| Name | UDrawFrustumComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/DrawFrustumComponent.h |
| Include Path | #include "Components/DrawFrustumComponent.h" |
Syntax
UCLASS (CollapseCategories, HideCategories=Object, EditInlineNew, MinimalAPI)
class UDrawFrustumComponent : public UPrimitiveComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UDrawFrustumComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDrawFrustumComponent
(
const FObjectInitializer& ObjectInitializer |
Components/DrawFrustumComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFrustumEnabled | bool | Enable or disable frustum visualization for this camera. | Components/DrawFrustumComponent.h |
|
| FrustumAngle | float | Angle of longest dimension of view shape. If the angle is 0 then an orthographic projection is used | Components/DrawFrustumComponent.h |
|
| FrustumAspectRatio | float | Ratio of horizontal size over vertical size. | Components/DrawFrustumComponent.h |
|
| FrustumColor | FColor | Color to draw the wireframe frustum. | Components/DrawFrustumComponent.h |
|
| FrustumEndDist | float | Distance from origin to stop drawing the frustum. | Components/DrawFrustumComponent.h |
|
| FrustumStartDist | float | Distance from origin to start drawing the frustum. | Components/DrawFrustumComponent.h |
|
| Texture | TObjectPtr< class UTexture > | Optional texture to show on the near plane | Components/DrawFrustumComponent.h |
|
Functions
Public
Overridden from UPrimitiveComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPrimitiveSceneProxy * CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. | Components/DrawFrustumComponent.h | |
virtual bool GetIgnoreBoundsForEditorFocus () |
Whether or not the bounds of this component should be considered when focusing the editor camera to an actor with this component in it. | Components/DrawFrustumComponent.h |
Overridden from USceneComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. | Components/DrawFrustumComponent.h |