Open 3D Engine Atom Gem API Reference 24.09.2
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AtomToolsFramework::DynamicProperty Struct Reference

#include <DynamicProperty.h>

Public Member Functions

 AZ_TYPE_INFO (DynamicProperty, "{B0E7DCC6-65D9-4F0C-86AE-AE768BC027F3}")
 
 AZ_CLASS_ALLOCATOR (DynamicProperty, AZ::SystemAllocator)
 
 DynamicProperty (const DynamicPropertyConfig &config)
 
void SetValue (const AZStd::any &value)
 Set property value.
 
const AZStd::any & GetValue () const
 Returns the current property value.
 
void SetConfig (const DynamicPropertyConfig &config)
 Set property config.
 
const DynamicPropertyConfigGetConfig () const
 Returns the current property value.
 
void UpdateEditData ()
 Rebuilds the dynamic edit data.
 
bool IsValid () const
 Returns true if the property has a valid value.
 
const AZ::Name GetId () const
 Returns the ID of the property.
 
AZ::Crc32 GetVisibility () const
 Returns the current property visibility.
 
bool IsReadOnly () const
 Returns the current property read only state.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static const AZ::Edit::ElementData * GetPropertyEditData (const void *handlerPtr, const void *elementPtr, const AZ::Uuid &elementType)
 

Detailed Description

Wraps an AZStd::any value and configuration so that it can be displayed and edited in a ReflectedPropertyEditor. Binds all of the data and attributes necessary to configure the controls used for editing in a ReflectedPropertyEditor. Does data validation for range-based properties like sliders and spin boxes.


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