Navigation
API > API/Plugins > API/Plugins/SoundScape
| Name | USoundscapeColorPointHashMap |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Soundscape/Source/SoundScape/Public/SoundscapeSubsystem.h |
| Include Path | #include "SoundscapeSubsystem.h" |
Syntax
UCLASS ()
class USoundscapeColorPointHashMap : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USoundscapeColorPointHashMap
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| HalfMaxGridWidth | const int32 | SoundscapeSubsystem.h | |
| MaxGridWidth | const int32 | Cubic Root of the Max Value of int64 rounded down to the nearest million. | SoundscapeSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColorPointHashMap | TMap< FGameplayTag, TObjectPtr< USoundscapeColorPointHashCellDensity > > | Color Point Hash Map. | SoundscapeSubsystem.h | |
| GridCenter | FVector | Current Grid Centerpoint. | SoundscapeSubsystem.h | |
| GridOriginOffset | FVector | Grid Origin Offset. | SoundscapeSubsystem.h | |
| GridWidth | int32 | MaxGridWidth / Hash Cell Size. | SoundscapeSubsystem.h | |
| HashCellFactor | float | Cell Size Inverted. | SoundscapeSubsystem.h | |
| HashCellSize | float | Hash Cell Width. | SoundscapeSubsystem.h | |
| NumCells | int64 | Grid Width Cubed. | SoundscapeSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddColorPointArrayToHash
(
const TArray< FVector >& Locations, |
Returns true if ColorPoint added to hash, false if failed (likely location is out of Hash Bounds) | SoundscapeSubsystem.h | |
bool AddColorPointToHash
(
const FVector& Location, |
Returns true if ColorPoint added to hash, false if failed (likely location is out of Hash Bounds) | SoundscapeSubsystem.h | |
uint64 CalculateHashIndex
(
const FVector& Location |
Calculates Hash Index. | SoundscapeSubsystem.h | |
void ClearHash() |
Clears hash map. | SoundscapeSubsystem.h | |
const FVector GetHashCellCenterpoint
(
FVector Location |
SoundscapeSubsystem.h | ||
const float GetHashCellWidth() |
SoundscapeSubsystem.h | ||
TMap< FGameplayTag, int32 > GetHashMapColorPointDensitySummary() |
SoundscapeSubsystem.h | ||
void InitializeHash
(
float HashCellSizeIn, |
Clears and initializes hash map, sizes grid to HashCellWidth in Uunits. | SoundscapeSubsystem.h | |
int32 NumColorPointsInCell
(
const FVector& Location, |
Returns the number of ColorPoints in a Cell containing the Location. | SoundscapeSubsystem.h | |
void SetGridCenterpoint
(
const FVector& Location |
Sets ceterpoint of grid to Location. | SoundscapeSubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USoundscapeColorPointHashCellDensity * GetColorPointDensityMap
(
FGameplayTag ColorPoint |
Returns ColorPointDensityMap from Hash Map given a Color Point. | SoundscapeSubsystem.h |