AVolume

An editable 3D volume placed in a level. Different types of volumes perform different functions

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/Volume.h

Include

#include "GameFramework/Volume.h"

Syntax

class AVolume : public ABrush

Remarks

An editable 3D volume placed in a level. Different types of volumes perform different functions

Constructors

Name Description

Public function

AVolume

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

EncompassesPoint

(
    FVector Point,
    float SphereRadius,
    float* OutDistanceToPoint
)

Public function Const

FBoxSphereBo...

 

GetBounds()

Public function Static

FOnVolumeSha...

 

GetOnVolumeShapeChangedDelegate()

Function to get the 'Volume imported' delegate

Overridden from ABrush

Name Description

Public function Virtual Const

bool

 

IsStaticBrush()

Public function Virtual Const

bool

 

IsVolumeBrush()

Overridden from AActor

Name Description

Public function 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.

Public function Virtual Const

bool

 

IsLevelBoundsRelevant()

Indicates whether this actor should participate in level bounds calculations

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostEditImport()

Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

Typedefs

Name

Description

FOnVolumeShapeChanged

Delegate used for notifications when a volumes initial shape changes

Constants

Name

Description

OnVolumeShapeChanged

Called during posteditchange after the volume's initial shape has changed

Define static delegate

See Also

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback