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::SequenceComponent Class Reference

Inherits AZ::Component, and Maestro::SequenceComponentRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (SequenceComponent, "{027CE988-CF48-4589-A73A-73CD8D02F783}")
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
bool SetAnimatedPropertyValue (const AZ::EntityId &animatedEntityId, const AnimatablePropertyAddress &animatableAddress, const AnimatedValue &value) override
 
void GetAnimatedPropertyValue (AnimatedValue &returnValue, const AZ::EntityId &animatedEntityId, const AnimatablePropertyAddress &animatableAddress) 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 Play () override
 
void PlayBetweenTimes (float startTime, float endTime) override
 
void Stop () override
 
void Pause () override
 
void Resume () override
 
void SetPlaySpeed (float newSpeed) override
 
void JumpToTime (float newTime) override
 
void JumpToEnd () override
 
void JumpToBeginning () override
 
float GetCurrentPlayTime () override
 
float GetPlaySpeed () 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)
 

Friends

class EditorSequenceComponent
 

Member Function Documentation

◆ GetAnimatedPropertyValue()

void Maestro::SequenceComponent::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

◆ GetAssetDuration()

void Maestro::SequenceComponent::GetAssetDuration ( AnimatedValue &  returnValue,
const AZ::EntityId &  animatedEntityId,
AZ::ComponentId  componentId,
const AZ::Data::AssetId &  assetId 
)
override

Track View will expect some components (those using AZ::Data::AssetBlends as a virtual property) to supply a GetAssetDuration event so Track View can query the duration of an asset (like a motion) without having any knowledge of that that asset is.

◆ SetAnimatedPropertyValue()

bool Maestro::SequenceComponent::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: