Elevate Engine 1
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
WwiseItem Struct Reference

#include <WwiseItem.h>

Inheritance diagram for WwiseItem:
WwiseAuxBus WwiseBus WwiseEvent WwiseGameParameter WwiseSoundbank WwiseState WwiseStateGroup WwiseSwitch WwiseSwitchGroup

Public Member Functions

bool HasValidShortID ()
 
bool IsAnyOfType (std::initializer_list< WwiseType > types) const
 
bool IsDirectory () const
 
void AddChildren (std::shared_ptr< WwiseItem > newChild)
 
bool HasChildren () const
 
bool IsEvent () const
 
WwiseType GetContainerType () const
 
std::string GetTypeName () const
 

Static Public Member Functions

static WwiseItemPtr Create ()
 

Public Attributes

std::string Name
 
std::string Path
 
std::string GUID
 
uint32_t ShortID
 
WwiseType Type
 
std::vector< WwiseItemPtr > Children
 
bool IsOnDisk = false
 
bool IsInBank = false
 
bool IsInWwise = false
 

Detailed Description

Definition at line 42 of file WwiseItem.h.

Member Function Documentation

◆ AddChildren()

void WwiseItem::AddChildren ( std::shared_ptr< WwiseItem >  newChild)

Definition at line 82 of file WwiseItem.cpp.

83{
84 if (newChild)
85 {
86 Children.push_back(newChild);
87 }
88}
WwiseItem::Children
std::vector< WwiseItemPtr > Children
Definition WwiseItem.h:49

◆ Create()

WwiseItemPtr WwiseItem::Create ( )
static

Definition at line 3 of file WwiseItem.cpp.

4{
5 return std::make_shared<WwiseItem>();
6}

◆ GetContainerType()

WwiseType WwiseItem::GetContainerType ( ) const

Definition at line 100 of file WwiseItem.cpp.

101{
102 // For root folders
103 if (!IsDirectory()) return WwiseType::None;
104
105 if (Name == "Busses") return WwiseType::Bus;
106 else if (Name == "Devices") return WwiseType::AudioDevice;
107 else if (Name == "Events") return WwiseType::Event;
108 else if (Name == "Switches") return WwiseType::Switch;
109 else if (Name == "StateGroup") return WwiseType::StateGroup;
110 else if (Name == "States") return WwiseType::State;
111 else if (Name == "GameParameter") return WwiseType::GameParameter;
112 else if (Name == "Effects") return WwiseType::Effect;
113 else if (Name == "Triggers") return WwiseType::Trigger;
114 else return WwiseType::Unknown;
115}
WwiseItem::Name
std::string Name
Definition WwiseItem.h:44
WwiseItem::IsDirectory
bool IsDirectory() const
Definition WwiseItem.cpp:77

◆ GetTypeName()

std::string WwiseItem::GetTypeName ( ) const

Definition at line 25 of file WwiseItem.cpp.

26{
27 switch (Type)
28 {
29 case WwiseType::TreeRoot:
30 return "Tree Root";
31 break;
32 case WwiseType::RootDirectory:
33 return "Root Directory";
34 break;
35 case WwiseType::WorkUnit:
36 return "Work Unit";
37 break;
38 case WwiseType::VirtualFolder:
39 return "Virtual Folder";
40 break;
41 case WwiseType::Event:
42 return "Event";
43 break;
44 case WwiseType::Bus:
45 return "Bus";
46 break;
47 case WwiseType::SwitchGroup:
48 return "Switch Group";
49 break;
50 case WwiseType::Switch:
51 return "Switch";
52 break;
53 case WwiseType::StateGroup:
54 return "State Group";
55 break;
56 case WwiseType::State:
57 return "State";
58 break;
59 case WwiseType::GameParameter:
60 return "Game Parameter";
61 break;
62 case WwiseType::Effect:
63 return "Effect ";
64 break;
65 case WwiseType::Trigger:
66 return "Trigger";
67 break;
68 case WwiseType::AudioDevice:
69 return "Audio Device";
70 break;
71 default:
72 return "Unknown";
73 break;
74 }
75}
WwiseItem::Type
WwiseType Type
Definition WwiseItem.h:48

◆ HasChildren()

bool WwiseItem::HasChildren ( ) const

Definition at line 90 of file WwiseItem.cpp.

91{
92 return !Children.empty();
93}

◆ HasValidShortID()

bool WwiseItem::HasValidShortID ( )

Definition at line 8 of file WwiseItem.cpp.

9{
10 return ShortID != 0;
11}
WwiseItem::ShortID
uint32_t ShortID
Definition WwiseItem.h:47

◆ IsAnyOfType()

bool WwiseItem::IsAnyOfType ( std::initializer_list< WwiseType >  types) const

Definition at line 13 of file WwiseItem.cpp.

14{
15 for (const auto& type : types)
16 {
17 if (type == Type)
18 {
19 return true;
20 }
21 }
22 return false;
23}

◆ IsDirectory()

bool WwiseItem::IsDirectory ( ) const

Definition at line 77 of file WwiseItem.cpp.

78{
79 return IsAnyOfType({ WwiseType::WorkUnit, WwiseType::VirtualFolder, WwiseType::StateGroup, WwiseType::SwitchGroup, WwiseType::Bus, WwiseType::RootDirectory });
80}
WwiseItem::IsAnyOfType
bool IsAnyOfType(std::initializer_list< WwiseType > types) const
Definition WwiseItem.cpp:13

◆ IsEvent()

bool WwiseItem::IsEvent ( ) const

Definition at line 95 of file WwiseItem.cpp.

96{
97 return Type == WwiseType::Event;
98}

Member Data Documentation

◆ Children

std::vector<WwiseItemPtr> WwiseItem::Children

Definition at line 49 of file WwiseItem.h.

◆ GUID

std::string WwiseItem::GUID

Definition at line 46 of file WwiseItem.h.

◆ IsInBank

bool WwiseItem::IsInBank = false

Definition at line 52 of file WwiseItem.h.

◆ IsInWwise

bool WwiseItem::IsInWwise = false

Definition at line 53 of file WwiseItem.h.

◆ IsOnDisk

bool WwiseItem::IsOnDisk = false

Definition at line 51 of file WwiseItem.h.

◆ Name

std::string WwiseItem::Name

Definition at line 44 of file WwiseItem.h.

◆ Path

std::string WwiseItem::Path

Definition at line 45 of file WwiseItem.h.

◆ ShortID

uint32_t WwiseItem::ShortID

Definition at line 47 of file WwiseItem.h.

◆ Type

WwiseType WwiseItem::Type

Definition at line 48 of file WwiseItem.h.

The documentation for this struct was generated from the following files: