Class representing an object hierarchy node. More...

#include <hierarchy.h>

Inheritance diagram for BlamScenarioHierarchyNode_Object:

Collaboration diagram for BlamScenarioHierarchyNode_Object:

Public Member Functions
	BlamScenarioHierarchyNode_Object ()
	Constructs a new object hierarchy node. More...

	BlamScenarioHierarchyNode_Object (std::string custom_name)
	Constructs a new object hierarchy node. More...

	~BlamScenarioHierarchyNode_Object ()

std::string	GetName ()
	Retrieves the display name of the hierarchy node. More...

std::string	GetTypeLabel ()
	Creates a 'Type' label for the node to be shown to the user. More...

std::string	GetClassLabel ()
	Creates a 'Class' label for the node to be shown to the user. More...

Public Member Functions inherited from BlamScenarioHierarchyNode
	BlamScenarioHierarchyNode (BlamScenarioHierarchyNodeType _node_type)
	Constructs a new scenario hierarchy node. More...

	BlamScenarioHierarchyNode (BlamScenarioHierarchyNodeType _node_type, std::string _display_name_override)
	Constructs a new scenario hierarchy node. More...

virtual	~BlamScenarioHierarchyNode ()

BlamScenarioHierarchyNodeType	GetType ()
	Retrieves the type of this node. More...

Public Attributes
BlamWorldObject *	world_object = nullptr
	The world object that this node refers to. More...

Public Attributes inherited from BlamScenarioHierarchyNode
BlamScenarioHierarchyNode *	parent_node = nullptr
	The parent node, if any, of this hierarchy node. More...

Additional Inherited Members
Protected Attributes inherited from BlamScenarioHierarchyNode
bool	use_custom_name = false
	Whether or not to use a custom display name for the node. More...

std::string	display_name_override = "unspecified"
	The custom display name of this hierarchy node. More...

Detailed Description

Class representing an object hierarchy node.

Objects within the hierarchy refer to any non-group object which can be manipulated.

Constructor & Destructor Documentation

◆ BlamScenarioHierarchyNode_Object() [1/2]

BlamScenarioHierarchyNode_Object::BlamScenarioHierarchyNode_Object ( )

Constructs a new object hierarchy node.

◆ BlamScenarioHierarchyNode_Object() [2/2]

BlamScenarioHierarchyNode_Object::BlamScenarioHierarchyNode_Object ( std::string custom_name )

Constructs a new object hierarchy node.

Parameters

custom_name - The custom display name of this node.

◆ ~BlamScenarioHierarchyNode_Object()

BlamScenarioHierarchyNode_Object::~BlamScenarioHierarchyNode_Object ( )

Here is the call graph for this function:

Member Function Documentation

◆ GetClassLabel()

std::string BlamScenarioHierarchyNode_Object::GetClassLabel ( )

Creates a 'Class' label for the node to be shown to the user.

Returns: A class label for this node. If the node does not refer to a tag, will return NONE.

◆ GetName()

std::string BlamScenarioHierarchyNode_Object::GetName ( )

virtual

Retrieves the display name of the hierarchy node.

Returns: The display name of this hierarchy node.

Reimplemented from BlamScenarioHierarchyNode.

Here is the caller graph for this function:

◆ GetTypeLabel()

std::string BlamScenarioHierarchyNode_Object::GetTypeLabel ( )

Creates a 'Type' label for the node to be shown to the user.

Returns: A type label for this node.

Member Data Documentation

◆ world_object

BlamWorldObject* BlamScenarioHierarchyNode_Object::world_object = nullptr

The world object that this node refers to.

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

HEKSapien/components/hierarchy/hierarchy.h
HEKSapien/components/hierarchy/BlamScenarioHierarchyNode_Object.cpp

Public Member Functions

Public Attributes

Additional Inherited Members