 |
Blamite Game Engine - Sapien (Library)
00433.02.16.25.2127.blamite
The level editor application for the Blamite Game Engine.
|
Go to the documentation of this file.
6 #include <blam/api/api.h>
8 #ifdef SAPIEN_LIB_EXPORTS
9 #define SAPIEN_LIB_API __declspec(dllexport)
11 #define SAPIEN_LIB_API __declspec(dllimport)
35 bool use_custom_name =
false;
43 std::string display_name_override =
"unspecified";
76 virtual std::string GetName();
87 std::vector<BlamScenarioHierarchyNode*> child_nodes = std::vector<BlamScenarioHierarchyNode*>();
140 void RemoveNodeAt(
int index,
bool delete_object =
true);
167 std::vector<BlamScenarioHierarchyNode_Object*> GetAllObjectNodes();
178 BlamWorldObject* world_object =
nullptr;
206 std::string GetTypeLabel();
213 std::string GetClassLabel();
240 std::map<int, BlamScenarioHierarchyNode_Group*> folder_ids = std::map<int, BlamScenarioHierarchyNode_Group*>();
267 std::vector<BlamScenarioHierarchyNode_Object*> GetAllObjectNodes();
BlamScenarioHierarchyNode * parent_node
The parent node, if any, of this hierarchy node.
Definition: hierarchy.h:45
virtual ~BlamScenarioHierarchyNode()
Definition: hierarchy.h:62
BlamWorldObject * world_object
The world object that this node refers to.
Definition: hierarchy.h:178
SAPIEN_LIB_API BlamTag * GetActiveScenarioTag()
Retrieves the currently active scenario tag.
Definition: scenario.cpp:22
@ Group
Indicates the hierarchy node is a BlamScenarioHierarchyNode_Group.
void Refresh()
Rebuilds the entire hierarchy data from world state and active scenario, cleaning up old data in the ...
Definition: BlamScenarioHierarchy.cpp:24
sound_enable debug_objects debug_structure_auto
Definition: editor_init.txt:4
std::map< int, BlamScenarioHierarchyNode_Group * > folder_ids
A map containing a list of all folder IDs, and their respective node groups.
Definition: hierarchy.h:240
BlamScenarioHierarchyNodeType
Enumerator listing possible hierarchy node types.
Definition: hierarchy.h:19
BlamScenarioHierarchyNodeType GetType()
Retrieves the type of this node.
Definition: BlamScenarioHierarchyNode.cpp:20
std::vector< BlamScenarioHierarchyNode_Object * > GetAllObjectNodes()
Generates a list of all object nodes, within any child nodes.
Definition: BlamScenarioHierarchyNode_Group.cpp:121
#define SAPIEN_LIB_API
Definition: hierarchy.h:11
bool HasChild(BlamScenarioHierarchyNode *node)
Checks whether or not a node is a direct child of this node.
Definition: BlamScenarioHierarchyNode_Group.cpp:108
bool use_custom_name
Whether or not to use a custom display name for the node.
Definition: hierarchy.h:35
std::string display_name_override
The custom display name of this hierarchy node.
Definition: hierarchy.h:43
Namespace containing functions for interacting with the scenario hierarchy.
Definition: hierarchy.h:276
~BlamScenarioHierarchyNode_Object()
Definition: BlamScenarioHierarchyNode_Object.cpp:16
SAPIEN_LIB_API void SaveScenario()
Attempts to save the current hierarchy data back to the scenario tag.
Definition: hierarchy.cpp:29
std::string GetName()
Retrieves the display name of the hierarchy node.
Definition: BlamScenarioHierarchyNode_Object.cpp:42
std::string GetClassLabel()
Creates a 'Class' label for the node to be shown to the user.
Definition: BlamScenarioHierarchyNode_Object.cpp:84
int folder_id
The folder ID of this group. This number should be unique within the hierarchy.
Definition: hierarchy.h:90
void ReleaseData()
Releases any data used by this node.
Definition: BlamScenarioHierarchyNode_Group.cpp:31
SAPIEN_LIB_API void PrepareHierarchy()
Prepares a new scenario hierarchy.
Definition: hierarchy.cpp:7
BlamScenarioHierarchyNode_Group(std::string group_name, int _folder_id)
Constructs a new hierarchy group node.
Definition: BlamScenarioHierarchyNode_Group.cpp:3
Class representing a scenario hierarchy.
Definition: hierarchy.h:223
void AddChild(BlamScenarioHierarchyNode *node)
Adds a new item to this group node.
Definition: BlamScenarioHierarchyNode_Group.cpp:50
virtual std::string GetName()
Retrieves the display name of the hierarchy node.
Definition: BlamScenarioHierarchyNode.cpp:15
~BlamScenarioHierarchyNode_Group()
Definition: BlamScenarioHierarchyNode_Group.cpp:9
Base class for hierarchy nodes.
Definition: hierarchy.h:29
int GetChildCount()
Retrieves the total number of child nodes.
Definition: BlamScenarioHierarchyNode_Group.cpp:69
void ReleaseData()
Releases all memory used by the scenario hierarchy.
Definition: BlamScenarioHierarchy.cpp:209
SAPIEN_LIB_API int ReserveFolderIndex()
Definition: hierarchy.cpp:37
Class representing an object hierarchy node.
Definition: hierarchy.h:175
BlamScenarioHierarchyNode * GetChildAt(int index)
Retrieves the child node at the specified index.
Definition: BlamScenarioHierarchyNode_Group.cpp:59
BlamScenarioHierarchyNode_Object()
Constructs a new object hierarchy node.
Definition: BlamScenarioHierarchyNode_Object.cpp:5
Class representing a group hierarchy node.
Definition: hierarchy.h:84
SAPIEN_LIB_API BlamScenarioHierarchy * GetHierarchy()
Retrieves the current scenario hierarchy.
Definition: hierarchy.cpp:24
BlamScenarioHierarchy()
Constructs a new scenario hierarchy.
Definition: BlamScenarioHierarchy.cpp:14
std::string GetTypeLabel()
Creates a 'Type' label for the node to be shown to the user.
Definition: BlamScenarioHierarchyNode_Object.cpp:54
void RemoveNodeAt(int index, bool delete_object=true)
Removes the child node at the specified index.
Definition: BlamScenarioHierarchyNode_Group.cpp:74
SAPIEN_LIB_API void ReleaseHierarchy()
Releases any data used by the scenario hierarchy.
Definition: hierarchy.cpp:13
BlamScenarioHierarchyNode_Group * scenario_root_node
Pointer to the Scenario/Mission root node.
Definition: hierarchy.h:234
std::vector< BlamScenarioHierarchyNode_Object * > GetAllObjectNodes()
Generates a list of all object nodes, within any child hierarchy nodes.
Definition: BlamScenarioHierarchy.cpp:221
void RemoveNode(BlamScenarioHierarchyNode *node, bool delete_object=true)
Removes a specific child node from this group.
Definition: BlamScenarioHierarchyNode_Group.cpp:89
@ Object
Indicates the hierarchy node is a BlamScenarioHierarchyNode_Object.
BlamScenarioHierarchy * hierarchy_data
Definition: hierarchy.cpp:5
BlamScenarioHierarchyNode(BlamScenarioHierarchyNodeType _node_type)
Constructs a new scenario hierarchy node.
Definition: BlamScenarioHierarchyNode.cpp:3
@ Undefined
Indicates the hierarchy node is an undefined type. Any node with this type should be considered inval...
~BlamScenarioHierarchy()
Called when the hierarchy is being destroyed.
Definition: BlamScenarioHierarchy.cpp:19