Navigation
API > API/Runtime > API/Runtime/Engine
An editable 3D volume placed in a level. Different types of volumes perform different functions
| Name | AVolume |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/GameFramework/Volume.h |
| Include Path | #include "GameFramework/Volume.h" |
Syntax
UCLASS (ShowCategories=Collision, HideCategories=(Brush, Physics), Abstract, ConversionRoot,
MinimalAPI)
class AVolume : public ABrush
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ABrush → AVolume
Derived Classes
AVolume derived class hierarchy
- AAudioVolume
- ABlockingVolume
- ACameraBlockingVolume
- ACullDistanceVolume
- ADEPRECATED_WorldPartitionVolume
- AHierarchicalLODVolume
- ALevelStreamingVolume
- ALightmassCharacterIndirectDetailVolume
- ALightmassImportanceVolume
- ALocationVolume
- AMeshMergeCullingVolume
- ANavMeshBoundsVolume
- ANavModifierVolume
- APCGVolume
- APhysicsVolume
- APostProcessVolume
- APrecomputedVisibilityOverrideVolume
- APrecomputedVisibilityVolume
- ATriggerVolume
- AVisualLoggerFilterVolume
- AVolumetricLightmapDensityVolume
- AWorldPartitionMiniMapVolume
- AAudioGameplayVolume
- ALidarClippingVolume
- AProceduralFoliageBlockingVolume
- AProceduralFoliageVolume
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AVolume
(
const FObjectInitializer& ObjectInitializer |
GameFramework/Volume.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnVolumeShapeChanged | TMulticastDelegate_OneParam< void, AVolume & > | Delegate used for notifications when a volumes initial shape changes | GameFramework/Volume.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnVolumeShapeChanged | FOnVolumeShapeChanged | Called during posteditchange after the volume's initial shape has changed |
Define static delegate | GameFramework/Volume.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool EncompassesPoint
(
FVector Point, |
GameFramework/Volume.h | ||
FBoxSphereBounds GetBounds() |
GameFramework/Volume.h | ||
virtual bool ShouldCheckCollisionComponentForErrors() |
GameFramework/Volume.h |
Overridden from ABrush
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsStaticBrush() |
GameFramework/Volume.h | ||
virtual bool IsVolumeBrush() |
GameFramework/Volume.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CheckForErrors() |
Function that gets called from within Map_Check to allow this actor to check itself for any potential errors and register them with map check dialog. | GameFramework/Volume.h | |
virtual FName GetCustomIconName() |
Returns a custom brush icon name to use in place of the automatic class icon where actors are represented via 2d icons in the editor (e.g scene outliner and menus) | GameFramework/Volume.h | |
virtual bool IsLevelBoundsRelevant() |
Indicates whether this actor should participate in level bounds calculations | GameFramework/Volume.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
GameFramework/Volume.h | ||
virtual void PostEditImport() |
GameFramework/Volume.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FOnVolumeShapeChanged & GetOnVolumeShapeChangedDelegate() |
Function to get the 'Volume imported' delegate | GameFramework/Volume.h |