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

#include <BaseNode.h>

Inherits GraphModel::Node.

Inherited by LandscapeCanvas::AssetWeightSelectorNode, LandscapeCanvas::BaseAreaFilterNode, LandscapeCanvas::BaseAreaModifierNode, LandscapeCanvas::BaseAreaNode, LandscapeCanvas::BaseGradientModifierNode, LandscapeCanvas::BaseGradientNode, LandscapeCanvas::BaseShapeNode, LandscapeCanvas::GradientMixerNode, LandscapeCanvas::PhysXHeightfieldColliderNode, LandscapeCanvas::ReferenceShapeNode, LandscapeCanvas::TerrainHeightGradientListNode, LandscapeCanvas::TerrainLayerSpawnerNode, LandscapeCanvas::TerrainMacroMaterialNode, LandscapeCanvas::TerrainPhysicsHeightfieldColliderNode, LandscapeCanvas::TerrainSurfaceGradientListNode, and LandscapeCanvas::TerrainSurfaceMaterialsListNode.

Public Types

enum  BaseNodeType {
  Invalid = -1 , Shape , VegetationArea , Gradient ,
  GradientGenerator , GradientModifier , TerrainArea , TerrainExtender ,
  TerrainSurfaceExtender , VegetationAreaModifier , VegetationAreaFilter , VegetationAreaSelector
}
 
using BaseNodePtr = AZStd::shared_ptr< BaseNode >
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (BaseNode, AZ::SystemAllocator)
 
 AZ_RTTI (BaseNode, "{94ECF2FF-C46C-4CCA-878C-5C47B943B6B7}", Node)
 
 BaseNode (GraphModel::GraphPtr graph)
 
virtual const BaseNodeType GetBaseNodeType () const
 
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)
 

Protected Member Functions

void CreateEntityNameSlot ()
 Create the property slot on our node to show the Entity name.
 

Protected Attributes

AZ::EntityId m_vegetationEntityId
 EntityId of the Vegetation Entity that holds this node.
 
AZ::ComponentId m_componentId = AZ::InvalidComponentId
 

Detailed Description

Base Node class that all our LandscapeCanvas nodes must derive from for tracking the associated vegetation Entity that holds the node, and other common functionality

Member Function Documentation

◆ GetComponent()

AZ::Component* LandscapeCanvas::BaseNode::GetComponent ( ) const

Retrieve a pointer to the Component on the respective Entity that this Node represents

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