Open 3D Engine AzToolsFramework API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Types | Public Member Functions | Friends | List of all members
AzToolsFramework::SliceRelationshipNode Class Reference

Classes

struct  HashSliceRelationshipNodeComparator
 
struct  HashSliceRelationshipNodeKey
 

Public Types

using SliceRelationshipNodeSet = AZStd::unordered_set< AZStd::shared_ptr< SliceRelationshipNode >, HashSliceRelationshipNodeKey, HashSliceRelationshipNodeComparator >
 

Public Member Functions

 SliceRelationshipNode (const AZStd::string &sliceRelativePath)
 
 SliceRelationshipNode (const AZStd::string &sliceRelativePath, AZ::Crc32 relativePathCrc)
 
bool AddDependent (const AZStd::shared_ptr< SliceRelationshipNode > &dependent)
 Adds a dependent to this Relationship node.
 
bool AddDependency (const AZStd::shared_ptr< SliceRelationshipNode > &dependency)
 Adds a dependency to this Relationship node.
 
const SliceRelationshipNodeSet & GetDependents () const
 Returns the set of all dependent slice relationship nodes.
 
const SliceRelationshipNodeSet & GetDependencies () const
 Returns the set of all slice relationship nodes that this one depends on.
 
const AZStd::string & GetSliceRelativePath () const
 Returns the relative path of this slice.
 
const AZ::Crc32 & GetRelativePathCrc () const
 Returns a Crc to the relative path of this slice.
 

Friends

class SliceDependencyBrowserComponent
 

Member Function Documentation

◆ AddDependency()

bool AzToolsFramework::SliceRelationshipNode::AddDependency ( const AZStd::shared_ptr< SliceRelationshipNode > &  dependency)

Adds a dependency to this Relationship node.

Parameters
AZStd::shared_ptr<SliceRelationshipNode>dependency The dependency node
Returns
bool true if a dependency was added false otherwise

◆ AddDependent()

bool AzToolsFramework::SliceRelationshipNode::AddDependent ( const AZStd::shared_ptr< SliceRelationshipNode > &  dependent)

Adds a dependent to this Relationship node.

Parameters
AZStd::shared_ptr<SliceRelationshipNode>dependent The dependent node
Returns
bool true if a dependent was added false otherwise

◆ GetDependencies()

const SliceRelationshipNodeSet & AzToolsFramework::SliceRelationshipNode::GetDependencies ( ) const

Returns the set of all slice relationship nodes that this one depends on.

Returns
const AzToolsFramework::SliceRelationshipNode::SliceRelationshipNodeSet& The set of all slice relationship nodes that this one depends on

◆ GetDependents()

const SliceRelationshipNodeSet & AzToolsFramework::SliceRelationshipNode::GetDependents ( ) const

Returns the set of all dependent slice relationship nodes.

Returns
const AzToolsFramework::SliceRelationshipNode::SliceRelationshipNodeSet& The set of all dependent slice relationship nodes

◆ GetRelativePathCrc()

const AZ::Crc32 & AzToolsFramework::SliceRelationshipNode::GetRelativePathCrc ( ) const

Returns a Crc to the relative path of this slice.

Returns
const AzToolsFramework::AZ::Crc32&

◆ GetSliceRelativePath()

const AZStd::string & AzToolsFramework::SliceRelationshipNode::GetSliceRelativePath ( ) const

Returns the relative path of this slice.

Returns
const AZStd::string& Relative path of this slice
The documentation for this class was generated from the following file: