|
|
| AnimationController (Context *context) |
| | Construct.
|
| |
|
| ~AnimationController () override |
| | Destruct.
|
| |
| void | OnSetEnabled () override |
| | Handle enabled/disabled state change. More...
|
| |
|
virtual void | Update (float timeStep) |
| | Update the animations. Is called from HandleScenePostUpdate().
|
| |
|
bool | Play (const String &name, unsigned char layer, bool looped, float fadeInTime=0.0f) |
| | Play an animation and set full target weight. Name must be the full resource name. Return true on success.
|
| |
|
bool | PlayExclusive (const String &name, unsigned char layer, bool looped, float fadeTime=0.0f) |
| | Play an animation, set full target weight and fade out all other animations on the same layer. Name must be the full resource name. Return true on success.
|
| |
|
bool | Stop (const String &name, float fadeOutTime=0.0f) |
| | Stop an animation. Zero fadetime is instant. Return true on success.
|
| |
|
void | StopLayer (unsigned char layer, float fadeOutTime=0.0f) |
| | Stop all animations on a specific layer. Zero fadetime is instant.
|
| |
|
void | StopAll (float fadeOutTime=0.0f) |
| | Stop all animations. Zero fadetime is instant.
|
| |
|
bool | Fade (const String &name, float targetWeight, float fadeTime) |
| | Fade animation to target weight. Return true on success.
|
| |
|
bool | FadeOthers (const String &name, float targetWeight, float fadeTime) |
| | Fade other animations on the same layer to target weight. Return true on success.
|
| |
|
bool | SetLayer (const String &name, unsigned char layer) |
| | Set animation blending layer priority. Return true on success.
|
| |
|
bool | SetStartBone (const String &name, const String &startBoneName) |
| | Set animation start bone. Return true on success.
|
| |
|
bool | SetTime (const String &name, float time) |
| | Set animation time position. Return true on success.
|
| |
|
bool | SetWeight (const String &name, float weight) |
| | Set animation weight. Return true on success.
|
| |
|
bool | SetLooped (const String &name, bool enable) |
| | Set animation looping. Return true on success.
|
| |
|
bool | SetSpeed (const String &name, float speed) |
| | Set animation speed. Return true on success.
|
| |
|
bool | SetAutoFade (const String &name, float fadeOutTime) |
| | Set animation autofade at end (non-looped animations only). Zero time disables. Return true on success.
|
| |
|
bool | SetRemoveOnCompletion (const String &name, bool removeOnCompletion) |
| | Set whether an animation auto-removes on completion.
|
| |
|
bool | SetBlendMode (const String &name, AnimationBlendMode mode) |
| | Set animation blending mode. Return true on success.
|
| |
|
bool | IsPlaying (const String &name) const |
| | Return whether an animation is active. Note that non-looping animations that are being clamped at the end also return true.
|
| |
|
bool | IsPlaying (unsigned char layer) const |
| | Return whether any animation is active on a specific layer.
|
| |
|
bool | IsFadingIn (const String &name) const |
| | Return whether an animation is fading in.
|
| |
|
bool | IsFadingOut (const String &name) const |
| | Return whether an animation is fading out.
|
| |
|
bool | IsAtEnd (const String &name) const |
| | Return whether an animation is at its end. Will return false if the animation is not active at all.
|
| |
|
unsigned char | GetLayer (const String &name) const |
| | Return animation blending layer.
|
| |
|
Bone * | GetStartBone (const String &name) const |
| | Return animation start bone, or null if no such animation.
|
| |
|
const String & | GetStartBoneName (const String &name) const |
| | Return animation start bone name, or empty string if no such animation.
|
| |
|
float | GetTime (const String &name) const |
| | Return animation time position.
|
| |
|
float | GetWeight (const String &name) const |
| | Return animation weight.
|
| |
|
bool | IsLooped (const String &name) const |
| | Return animation looping.
|
| |
|
AnimationBlendMode | GetBlendMode (const String &name) const |
| | Return animation blending mode.
|
| |
|
float | GetLength (const String &name) const |
| | Return animation length.
|
| |
|
float | GetSpeed (const String &name) const |
| | Return animation speed.
|
| |
|
float | GetFadeTarget (const String &name) const |
| | Return animation fade target weight.
|
| |
|
float | GetFadeTime (const String &name) const |
| | Return animation fade time.
|
| |
|
float | GetAutoFade (const String &name) const |
| | Return animation autofade time.
|
| |
|
bool | GetRemoveOnCompletion (const String &name) const |
| | Return whether animation auto-removes on completion, or false if no such animation.
|
| |
|
AnimationState * | GetAnimationState (const String &name) const |
| | Find an animation state by animation name.
|
| |
|
AnimationState * | GetAnimationState (StringHash nameHash) const |
| | Find an animation state by animation name hash.
|
| |
|
const Vector< AnimationControl > & | GetAnimations () const |
| | Return the animation control structures for inspection.
|
| |
|
void | SetAnimationsAttr (const VariantVector &value) |
| | Set animation control structures attribute.
|
| |
|
void | SetNetAnimationsAttr (const Vector< byte > &value) |
| | Set animations attribute for network replication.
|
| |
|
void | SetNodeAnimationStatesAttr (const VariantVector &value) |
| | Set node animation states attribute.
|
| |
|
VariantVector | GetAnimationsAttr () const |
| | Return animation control structures attribute.
|
| |
|
const Vector< byte > & | GetNetAnimationsAttr () const |
| | Return animations attribute for network replication.
|
| |
|
VariantVector | GetNodeAnimationStatesAttr () const |
| | Return node animation states attribute.
|
| |
|
| Component (Context *context) |
| | Construct.
|
| |
|
| ~Component () override |
| | Destruct.
|
| |
| virtual void | OnSetEnabled () |
| | Handle enabled/disabled state change. More...
|
| |
| bool | Save (Serializer &dest) const override |
| | Save as binary data. Return true if successful. More...
|
| |
| bool | SaveXML (XMLElement &dest) const override |
| | Save as XML data. Return true if successful. More...
|
| |
| bool | SaveJSON (JSONValue &dest) const override |
| | Save as JSON data. Return true if successful. More...
|
| |
| void | MarkNetworkUpdate () override |
| | Mark for attribute check on the next network update. More...
|
| |
| virtual void | GetDependencyNodes (Vector< Node * > &dest) |
| | Return the depended on nodes to order network updates. More...
|
| |
| virtual void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) |
| | Visualize the component as debug geometry. More...
|
| |
|
void | SetEnabled (bool enable) |
| | Set enabled/disabled state.
|
| |
|
void | Remove () |
| | Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
|
| |
|
ComponentId | GetID () const |
| | Return ID.
|
| |
|
bool | IsReplicated () const |
| | Return whether the component is replicated or local to a scene.
|
| |
|
Node * | GetNode () const |
| | Return scene node.
|
| |
|
Scene * | GetScene () const |
| | Return the scene the node belongs to.
|
| |
|
bool | IsEnabled () const |
| | Return whether is enabled.
|
| |
|
bool | IsEnabledEffective () const |
| | Return whether is effectively enabled (node is also enabled).
|
| |
|
Component * | GetComponent (StringHash type) const |
| | Return component in the same scene node by type. If there are several, returns the first.
|
| |
|
void | GetComponents (Vector< Component * > &dest, StringHash type) const |
| | Return components in the same scene node by type.
|
| |
|
template<class T > |
| T * | GetComponent () const |
| | Template version of returning a component in the same scene node by type.
|
| |
|
template<class T > |
| void | GetComponents (Vector< T * > &dest) const |
| | Template version of returning components in the same scene node by type.
|
| |
|
void | AddReplicationState (ComponentReplicationState *state) |
| | Add a replication state that is tracking this component.
|
| |
|
void | PrepareNetworkUpdate () |
| | Prepare network update by comparing attributes and marking replication states dirty as necessary.
|
| |
|
void | CleanupConnection (Connection *connection) |
| | Clean up all references to a network connection that is about to be removed.
|
| |
|
| Animatable (Context *context) |
| | Construct.
|
| |
|
| ~Animatable () override |
| | Destruct.
|
| |
| bool | LoadXML (const XMLElement &source) override |
| | Load from XML data. Return true if successful. More...
|
| |
| bool | SaveXML (XMLElement &dest) const override |
| | Save as XML data. Return true if successful. More...
|
| |
| bool | LoadJSON (const JSONValue &source) override |
| | Load from JSON data. Return true if successful. More...
|
| |
| bool | SaveJSON (JSONValue &dest) const override |
| | Save as JSON data. Return true if successful. More...
|
| |
|
void | SetAnimationEnabled (bool enable) |
| | Set automatic update of animation, default true.
|
| |
|
void | SetAnimationTime (float time) |
| | Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
|
| |
|
void | SetObjectAnimation (ObjectAnimation *objectAnimation) |
| | Set object animation.
|
| |
|
void | SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f) |
| | Set attribute animation.
|
| |
|
void | SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode) |
| | Set attribute animation wrap mode.
|
| |
|
void | SetAttributeAnimationSpeed (const String &name, float speed) |
| | Set attribute animation speed.
|
| |
|
void | SetAttributeAnimationTime (const String &name, float time) |
| | Set attribute animation time position manually. Automatic update should be disabled in this case.
|
| |
|
void | RemoveObjectAnimation () |
| | Remove object animation. Same as calling SetObjectAnimation with a null pointer.
|
| |
|
void | RemoveAttributeAnimation (const String &name) |
| | Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
|
| |
|
bool | GetAnimationEnabled () const |
| | Return animation enabled.
|
| |
|
ObjectAnimation * | GetObjectAnimation () const |
| | Return object animation.
|
| |
|
ValueAnimation * | GetAttributeAnimation (const String &name) const |
| | Return attribute animation.
|
| |
|
WrapMode | GetAttributeAnimationWrapMode (const String &name) const |
| | Return attribute animation wrap mode.
|
| |
|
float | GetAttributeAnimationSpeed (const String &name) const |
| | Return attribute animation speed.
|
| |
|
float | GetAttributeAnimationTime (const String &name) const |
| | Return attribute animation time position.
|
| |
|
void | SetObjectAnimationAttr (const ResourceRef &value) |
| | Set object animation attribute.
|
| |
|
ResourceRef | GetObjectAnimationAttr () const |
| | Return object animation attribute.
|
| |
|
| Serializable (Context *context) |
| | Construct.
|
| |
|
| ~Serializable () override |
| | Destruct.
|
| |
|
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
| | Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
|
| |
|
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) const |
| | Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
|
| |
| virtual const Vector< AttributeInfo > * | GetAttributes () const |
| | Return attribute descriptions, or null if none defined. More...
|
| |
|
virtual const Vector< AttributeInfo > * | GetNetworkAttributes () const |
| | Return network replication attribute descriptions, or null if none defined.
|
| |
| virtual bool | Load (Deserializer &source) |
| | Load from binary data. Return true if successful. More...
|
| |
| virtual bool | Save (Serializer &dest) const |
| | Save as binary data. Return true if successful. More...
|
| |
| virtual bool | LoadXML (const XMLElement &source) |
| | Load from XML data. Return true if successful. More...
|
| |
| virtual bool | SaveXML (XMLElement &dest) const |
| | Save as XML data. Return true if successful. More...
|
| |
| virtual bool | LoadJSON (const JSONValue &source) |
| | Load from JSON data. Return true if successful. More...
|
| |
| virtual bool | SaveJSON (JSONValue &dest) const |
| | Save as JSON data. Return true if successful. More...
|
| |
| virtual void | ApplyAttributes () |
| | Apply attribute changes that can not be applied immediately. Called after scene load or a network update. More...
|
| |
| virtual bool | SaveDefaultAttributes () const |
| | Return whether should save default-valued attributes into XML. Default false. More...
|
| |
| virtual void | MarkNetworkUpdate () |
| | Mark for attribute check on the next network update. More...
|
| |
|
bool | SetAttribute (unsigned index, const Variant &value) |
| | Set attribute by index. Return true if successfully set.
|
| |
|
bool | SetAttribute (const String &name, const Variant &value) |
| | Set attribute by name. Return true if successfully set.
|
| |
|
void | SetInstanceDefault (bool enable) |
| | Set instance-level default flag.
|
| |
|
void | ResetToDefault () |
| | Reset all editable attributes to their default values.
|
| |
|
void | RemoveInstanceDefault () |
| | Remove instance's default values if they are set previously.
|
| |
|
void | SetTemporary (bool enable) |
| | Set temporary flag. Temporary objects will not be saved.
|
| |
|
void | SetInterceptNetworkUpdate (const String &attributeName, bool enable) |
| | Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
|
| |
|
void | AllocateNetworkState () |
| | Allocate network attribute state.
|
| |
|
void | WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp) |
| | Write initial delta network update.
|
| |
|
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp) |
| | Write a delta network update according to dirty attribute bits.
|
| |
|
void | WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp) |
| | Write a latest data network update.
|
| |
|
bool | ReadDeltaUpdate (Deserializer &source) |
| | Read and apply a network delta update. Return true if attributes were changed.
|
| |
|
bool | ReadLatestDataUpdate (Deserializer &source) |
| | Read and apply a network latest data update. Return true if attributes were changed.
|
| |
|
Variant | GetAttribute (unsigned index) const |
| | Return attribute value by index. Return empty if illegal index.
|
| |
|
Variant | GetAttribute (const String &name) const |
| | Return attribute value by name. Return empty if not found.
|
| |
|
Variant | GetAttributeDefault (unsigned index) const |
| | Return attribute default value by index. Return empty if illegal index.
|
| |
|
Variant | GetAttributeDefault (const String &name) const |
| | Return attribute default value by name. Return empty if not found.
|
| |
|
unsigned | GetNumAttributes () const |
| | Return number of attributes.
|
| |
|
unsigned | GetNumNetworkAttributes () const |
| | Return number of network replication attributes.
|
| |
|
bool | IsTemporary () const |
| | Return whether is temporary.
|
| |
|
bool | GetInterceptNetworkUpdate (const String &attributeName) const |
| | Return whether an attribute's network updates are being intercepted.
|
| |
|
NetworkState * | GetNetworkState () const |
| | Return the network attribute state, if allocated.
|
| |
|
| Object (Context *context) |
| | Construct.
|
| |
|
| ~Object () override |
| | Destruct. Clean up self from event sender & receiver structures.
|
| |
| virtual StringHash | GetType () const =0 |
| | Return type hash. More...
|
| |
| virtual const String & | GetTypeName () const =0 |
| | Return type name. More...
|
| |
|
virtual const TypeInfo * | GetTypeInfo () const =0 |
| | Return type info.
|
| |
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| | Handle event.
|
| |
|
bool | IsInstanceOf (StringHash type) const |
| | Check current instance is type of specified type.
|
| |
|
bool | IsInstanceOf (const TypeInfo *typeInfo) const |
| | Check current instance is type of specified type.
|
| |
|
template<typename T > |
| bool | IsInstanceOf () const |
| | Check current instance is type of specified class.
|
| |
|
template<typename T > |
| T * | Cast () |
| | Cast the object to specified most derived class.
|
| |
|
template<typename T > |
| const T * | Cast () const |
| | Cast the object to specified most derived class.
|
| |
|
void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| | Subscribe to an event that can be sent by any sender.
|
| |
|
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| | Subscribe to a specific sender's event.
|
| |
|
void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| | Subscribe to an event that can be sent by any sender.
|
| |
|
void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| | Subscribe to a specific sender's event.
|
| |
|
void | UnsubscribeFromEvent (StringHash eventType) |
| | Unsubscribe from an event.
|
| |
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| | Unsubscribe from a specific sender's event.
|
| |
|
void | UnsubscribeFromEvents (Object *sender) |
| | Unsubscribe from a specific sender's events.
|
| |
|
void | UnsubscribeFromAllEvents () |
| | Unsubscribe from all events.
|
| |
|
void | UnsubscribeFromAllEventsExcept (const Vector< StringHash > &exceptions, bool onlyUserData) |
| | Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
|
| |
|
void | SendEvent (StringHash eventType) |
| | Send event to all subscribers.
|
| |
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| | Send event with parameters to all subscribers.
|
| |
|
VariantMap & | GetEventDataMap () const |
| | Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
|
| |
|
template<typename... Args> |
| void | SendEvent (StringHash eventType, Args... args) |
| | Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
|
| |
|
Context * | GetContext () const |
| | Return execution context.
|
| |
|
const Variant & | GetGlobalVar (StringHash key) const |
| | Return global variable based on key.
|
| |
|
const VariantMap & | GetGlobalVars () const |
| | Return all global variables.
|
| |
|
void | SetGlobalVar (StringHash key, const Variant &value) |
| | Set global variable with the respective key and value.
|
| |
|
Object * | GetSubsystem (StringHash type) const |
| | Return subsystem by type.
|
| |
|
Object * | GetEventSender () const |
| | Return active event sender. Null outside event handling.
|
| |
|
EventHandler * | GetEventHandler () const |
| | Return active event handler. Null outside event handling.
|
| |
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| | Return whether has subscribed to an event without specific sender.
|
| |
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| | Return whether has subscribed to a specific sender's event.
|
| |
|
bool | HasEventHandlers () const |
| | Return whether has subscribed to any event.
|
| |
|
template<class T > |
| T * | GetSubsystem () const |
| | Template version of returning a subsystem.
|
| |
|
const String & | GetCategory () const |
| | Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
|
| |
|
void | SetBlockEvents (bool block) |
| | Block object from sending and receiving events.
|
| |
|
bool | GetBlockEvents () const |
| | Return sending and receiving events blocking status.
|
| |
|
| RefCounted () |
| | Construct. Allocate the reference count structure and set an initial self weak reference.
|
| |
|
virtual | ~RefCounted () |
| | Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
| |
|
| RefCounted (const RefCounted &rhs)=delete |
| | Prevent copy construction.
|
| |
|
RefCounted & | operator= (const RefCounted &rhs)=delete |
| | Prevent assignment.
|
| |
|
void | AddRef () |
| | Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
|
| |
|
void | ReleaseRef () |
| | Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
|
| |
|
int | Refs () const |
| | Return reference count.
|
| |
|
int | WeakRefs () const |
| | Return weak reference count.
|
| |
|
RefCount * | RefCountPtr () |
| | Return pointer to the reference count structure.
|
| |
Public Member Functions inherited from Urho3D::Component