1. Epic GamesDeveloper
  3. FSpatialReadinessVolume

FSpatialReadinessVolume

API > API/Plugins > API/Plugins/SpatialReadiness

   
Name FSpatialReadinessVolume
Type class
Header File /Engine/Plugins/Experimental/SpatialReadiness/Source/SpatialReadiness/Public/SpatialReadinessVolume.h
Include Path #include "SpatialReadinessVolume.h"

Syntax

class FSpatialReadinessVolume

Constructors

Name Remarks Include Path Unreal Specifiers
Readiness handles are unique and cannot be copied. SpatialReadinessVolume.h  
Move constructor & assignment. SpatialReadinessVolume.h  

FSpatialReadinessVolume ( TWeakPtr< FSpatialReadinessAPIDelegates > InDelegates,
const FBox& InBounds,
const FString& InDescription
)

   SpatialReadinessVolume.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSpatialReadinessVolume()

 When a handle is destroyed, it will make the corresponding volume as ready. SpatialReadinessVolume.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Bounds FBox Bounds of the unready volume. SpatialReadinessVolume.h  
Delegates TWeakPtr< FSpatialReadinessAPIDelegates > Ref to the spatial readiness system. SpatialReadinessVolume.h  
Description FString Description of the reason why the volume referred to by this handle might be unready. SpatialReadinessVolume.h  
Index int32 Index used by the interface to select the related volume, if one exists (ie if this handle refers to an "unready" state). SpatialReadinessVolume.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool EnsureIsValid()

 Ensure that IsValid() returns true, printing a message and returning false if not. SpatialReadinessVolume.h  

const FString GetDebugString()

 Get a debug string for this volume. SpatialReadinessVolume.h  

const FString & GetDescription()

 Get the description of this handle - will be empty string if the WITH_SPATIAL_READINESS_DESCRIPTIONS macro is 0 SpatialReadinessVolume.h  

bool IsReady()

 Check to see if this handle points to a volume which is currently "ready". SpatialReadinessVolume.h  

bool IsValid()

 Check to make sure that the readiness system which created this handle did not go out of scope. SpatialReadinessVolume.h  

void MarkReady()

 Mark this volume as "ready". SpatialReadinessVolume.h  

void MarkUnready ( const FBox& NewBounds,
const FString& NewDescription
)

   SpatialReadinessVolume.h  

void MarkUnready ( const FString& NewDescription
)

   SpatialReadinessVolume.h  

void MarkUnready ()

 Mark this volume as "unready". SpatialReadinessVolume.h  

void MarkUnready ( const FBox& NewBounds
)

 Optional overrides to MakeUnready() for adjusting bounds and/or description. SpatialReadinessVolume.h  

void SetBounds ( const FBox& NewBounds
)

   SpatialReadinessVolume.h  

void SetDescription ( const FString& NewDescription
)

 Set properties, updating internals if necessary. SpatialReadinessVolume.h  

Operators

Name Remarks Include Path Unreal Specifiers
  SpatialReadinessVolume.h  
  SpatialReadinessVolume.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page