Open 3D Engine Maestro 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.
Maestro::EditorSequenceComponent Class Reference

Inherits AzToolsFramework::Components::EditorComponentBase, Maestro::EditorSequenceComponentRequestBus::Handler, Maestro::SequenceComponentRequestBus::Handler, and AZ::TickBus::Handler.

Public Types

using AnimatablePropertyAddress = Maestro::SequenceComponentRequests::AnimatablePropertyAddress
 
using AnimatedValue = Maestro::SequenceComponentRequests::AnimatedValue
 

Public Member Functions

 AZ_EDITOR_COMPONENT (EditorSequenceComponent, EditorSequenceComponentTypeId)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void GetAllAnimatablePropertiesForComponent (IAnimNode::AnimParamInfos &addressList, AZ::EntityId id, AZ::ComponentId componentId) override
 
void GetAnimatableComponents (AZStd::vector< AZ::ComponentId > &componentIds, AZ::EntityId id) override
 
void AddEntityToAnimate (AZ::EntityId entityToAnimate) override
 
void RemoveEntityToAnimate (AZ::EntityId removedEntityId) override
 
bool MarkEntityAsDirty () const override
 
AnimValueType GetValueType (const AZStd::string &animatableAddress) override
 
void GetAnimatedPropertyValue (AnimatedValue &returnValue, const AZ::EntityId &animatedEntityId, const AnimatablePropertyAddress &animatableAddress) override
 
bool SetAnimatedPropertyValue (const AZ::EntityId &animatedEntityId, const AnimatablePropertyAddress &animatableAddress, const AnimatedValue &value) override
 
AZ::Uuid GetAnimatedAddressTypeId (const AZ::EntityId &animatedEntityId, const Maestro::SequenceComponentRequests::AnimatablePropertyAddress &animatableAddress) override
 
void GetAssetDuration (AnimatedValue &returnValue, const AZ::EntityId &animatedEntityId, AZ::ComponentId componentId, const AZ::Data::AssetId &assetId) override
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
IAnimSequence * GetSequence ()
 

Protected Member Functions

void BuildGameEntity (AZ::Entity *gameEntity) override
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void Reflect (AZ::ReflectContext *context)
 

Member Function Documentation

◆ GetAnimatedPropertyValue()

void Maestro::EditorSequenceComponent::GetAnimatedPropertyValue ( AnimatedValue &  returnValue,
const AZ::EntityId &  animatedEntityId,
const AnimatablePropertyAddress &  animatableAddress 
)
override

Get the current value for a property

Parameters
returnValueholds the value to get - this must be instance of one of the concrete subclasses of AnimatedValue, corresponding to the type of the property referenced by the animatedAdresss
animatedEntityIdthe entity Id of the entity containing the animatedAddress
animatedAddressidentifies the component and property to be set

◆ SetAnimatedPropertyValue()

bool Maestro::EditorSequenceComponent::SetAnimatedPropertyValue ( const AZ::EntityId &  animatedEntityId,
const AnimatablePropertyAddress &  animatableAddress,
const AnimatedValue &  value 
)
override

Set a value for an animated property at the given address on the given entity.

Parameters
animatedEntityIdthe entity Id of the entity containing the animatedAddress
animatedAddressidentifies the component and property to be set
valuethe value to set - this must be instance of one of the concrete subclasses of AnimatedValue, corresponding to the type of the property referenced by the animatedAdresss
Returns
true if the value was changed.

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