Open 3D Engine LandscapeCanvas Gem API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
LandscapeCanvas::BaseAreaNode Class Reference

Inherits LandscapeCanvas::BaseNode.

Inherited by LandscapeCanvas::AreaBlenderNode, LandscapeCanvas::BlockerAreaNode, LandscapeCanvas::MeshBlockerAreaNode, and LandscapeCanvas::SpawnerAreaNode.

Public Member Functions

 AZ_CLASS_ALLOCATOR (BaseAreaNode, AZ::SystemAllocator)
 
 AZ_RTTI (BaseAreaNode, "{16CC0816-6A5F-4244-B66A-2D34B6D4E508}", BaseNode)
 
 BaseAreaNode (GraphModel::GraphPtr graph)
 
const char * GetSubTitle () const override
 
GraphModel::NodeType GetNodeType () const override
 
const BaseNodeType GetBaseNodeType () const override
 
AZ::Component * GetReferenceShapeComponent () const
 
- Public Member Functions inherited from LandscapeCanvas::BaseNode
 AZ_CLASS_ALLOCATOR (BaseNode, AZ::SystemAllocator)
 
 AZ_RTTI (BaseNode, "{94ECF2FF-C46C-4CCA-878C-5C47B943B6B7}", Node)
 
 BaseNode (GraphModel::GraphPtr graph)
 
const AZ::EntityId & GetVegetationEntityId () const
 
void SetVegetationEntityId (const AZ::EntityId &entityId)
 
void RefreshEntityName ()
 Refresh the name in the entity name property slot.
 
const AZ::ComponentId & GetComponentId () const
 
void SetComponentId (const AZ::ComponentId &componentId)
 
virtual AZ::ComponentDescriptor::DependencyArrayType GetOptionalRequiredServices () const
 
AZ::Component * GetComponent () const
 
bool IsAreaExtender () const
 Returns whether or not this node is a Vegetation Area Extender (Filter/Modifier/Selector)
 
void PostLoadSetup (GraphModel::GraphPtr graph, GraphModel::NodeId id) override
 Override the PostLoadSetup calls to ensure the entity name is refreshed correctly.
 
void PostLoadSetup () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from LandscapeCanvas::BaseNode
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void RegisterSlots () override
 
- Protected Member Functions inherited from LandscapeCanvas::BaseNode
void CreateEntityNameSlot ()
 Create the property slot on our node to show the Entity name.
 

Additional Inherited Members

- Public Types inherited from LandscapeCanvas::BaseNode
enum  BaseNodeType {
  Invalid = -1 , Shape , VegetationArea , Gradient ,
  GradientGenerator , GradientModifier , TerrainArea , TerrainExtender ,
  TerrainSurfaceExtender , VegetationAreaModifier , VegetationAreaFilter , VegetationAreaSelector
}
 
using BaseNodePtr = AZStd::shared_ptr< BaseNode >
 
- Protected Attributes inherited from LandscapeCanvas::BaseNode
AZ::EntityId m_vegetationEntityId
 EntityId of the Vegetation Entity that holds this node.
 
AZ::ComponentId m_componentId = AZ::InvalidComponentId
 

Member Function Documentation

◆ GetBaseNodeType()

const BaseNodeType LandscapeCanvas::BaseAreaNode::GetBaseNodeType ( ) const
inlineoverridevirtual

Reimplemented from LandscapeCanvas::BaseNode.

◆ GetReferenceShapeComponent()

AZ::Component * LandscapeCanvas::BaseAreaNode::GetReferenceShapeComponent ( ) const

Retrieve a pointer to the Reference Shape Component on this Entity if it exists (to be used for getting/setting the Placement Bounds)

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