Rebel Fork Framework
Urho3D::SplinePath Class Reference

Spline for creating smooth movement based on Speed along a set of Control Points modified by the Interpolation Mode. More...

#include <Urho3D/Scene/SplinePath.h>

Inheritance diagram for Urho3D::SplinePath:
Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 SplinePath (Context *context)
 Construct an Empty SplinePath.
 
 ~SplinePath () override=default
 Destructor.
 
void ApplyAttributes () override
 Apply Attributes to the SplinePath.
 
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Draw the Debug Geometry.
 
void AddControlPoint (Node *point, unsigned index=M_MAX_UNSIGNED)
 Add a Node to the SplinePath as a Control Point.
 
void RemoveControlPoint (Node *point)
 Remove a Node Control Point from the SplinePath.
 
void ClearControlPoints ()
 Clear the Control Points from the SplinePath.
 
void SetInterpolationMode (InterpolationMode interpolationMode)
 
void SetSpeed (float speed)
 
void SetPosition (float factor)
 Set the controlled Node's position on the SplinePath.
 
void SetControlledNode (Node *controlled)
 
InterpolationMode GetInterpolationMode () const
 
float GetSpeed () const
 
float GetLength () const
 
Vector3 GetPosition () const
 Get the parent Node's last position on the spline.
 
Node * GetControlledNode () const
 
Vector3 GetPoint (float factor) const
 Get a point on the SplinePath from 0.f to 1.f where 0 is the start and 1 is the end.
 
void Move (float timeStep)
 Move the controlled Node to the next position along the SplinePath based off the Speed value.
 
void Reset ()
 Reset movement along the path.
 
bool IsFinished () const
 
void SetControlPointIdsAttr (const VariantVector &value)
 Set Control Point Node IDs attribute.
 
const VariantVectorGetControlPointIdsAttr () const
 Return Control Point Node IDs attribute.
 
void SetControlledIdAttr (unsigned value)
 Set Controlled Node ID attribute.
 
unsigned GetControlledIdAttr () const
 Get Controlled Node ID attribute.
 
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
 
 ~Component () override
 Destruct.
 
virtual void OnSetEnabled ()
 Handle enabled/disabled state change.
 
AttributeScopeHint GetEffectiveScopeHint () const
 
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
 
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
 
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
 
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
 
virtual bool HasAuxiliaryData () const
 
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
 
void SetEnabled (bool enable)
 
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
 
unsigned GetID () const
 
Node * GetNode () const
 
SceneGetScene () const
 Return the scene the node belongs to.
 
bool IsEnabled () const
 
bool IsEnabledEffective () const
 
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
 
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
 
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
 
unsigned GetIndexInParent () const
 Return index of this component in the node.
 
- Public Member Functions inherited from Urho3D::Serializable
 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 ObjectReflectionGetReflection () const
 Return reflection used for serialization.
 
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
 
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
 
void SerializeInBlock (Archive &archive, bool serializeTemporary)
 
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
 
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
 
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
 
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
 
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
 
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
 
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
 
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
 
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
 
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
 
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)
 
Variant GetAttribute (unsigned index) const
 
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
 
bool IsTemporary () const
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const ea::string & GetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () 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 SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () 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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- Public Member Functions inherited from Urho3D::RefCounted
 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Protected Member Functions

void OnMarkedDirty (Node *point) override
 Listener to manage Control Point movement.
 
void OnNodeSetEnabled (Node *point) override
 Listener to manage Control Point enabling.
 
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSet (Node *previousNode, Node *currentNode)
 Handle scene node being assigned at creation.
 
virtual void OnSceneSet (Scene *scene)
 Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.
 
void SetID (unsigned id)
 
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
 
ComponentGetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
 
void DoAutoRemove (AutoRemoveMode mode)
 Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
 

Private Member Functions

 URHO3D_OBJECT (SplinePath, Component)
 
void UpdateNodeIds ()
 Update the Node IDs of the Control Points.
 
void CalculateLength ()
 Calculate the length of the SplinePath. Used for movement calculations.
 

Private Attributes

Spline spline_
 The Control Points of the Spline.
 
float speed_
 The Speed of movement along the Spline.
 
float elapsedTime_
 Amount of time that has elapsed while moving.
 
float traveled_
 The fraction of the SplinePath covered.
 
float length_
 The length of the SplinePath.
 
bool dirty_
 Whether the Control Point IDs are dirty.
 
WeakPtr< Node > controlledNode_
 Node to be moved along the SplinePath.
 
ea::vector< WeakPtr< Node > > controlPoints_
 Control Points for the SplinePath.
 
VariantVector controlPointIdsAttr_
 Control Point ID's for the SplinePath.
 
unsigned controlledIdAttr_
 Controlled ID for the SplinePath.
 

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
 
unsigned id_
 Unique ID within the scene.
 
bool networkUpdate_
 Network update queued flag.
 
bool enabled_
 Enabled flag.
 
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
 
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
 
bool temporary_
 Temporary flag.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Spline for creating smooth movement based on Speed along a set of Control Points modified by the Interpolation Mode.

Member Function Documentation

◆ GetControlledNode()

Node* Urho3D::SplinePath::GetControlledNode ( ) const
inline

Get the controlled Node.

◆ GetInterpolationMode()

InterpolationMode Urho3D::SplinePath::GetInterpolationMode ( ) const
inline

Get the Interpolation Mode.

◆ GetLength()

float Urho3D::SplinePath::GetLength ( ) const
inline

Get the length of SplinePath.

◆ GetSpeed()

float Urho3D::SplinePath::GetSpeed ( ) const
inline

Get the movement Speed.

◆ IsFinished()

bool Urho3D::SplinePath::IsFinished ( ) const
inline

Returns whether the movement along the SplinePath is complete.

◆ RegisterObject()

void Urho3D::SplinePath::RegisterObject ( Context context)
static

Register object factory.

◆ SetControlledNode()

void Urho3D::SplinePath::SetControlledNode ( Node *  controlled)

Set the Node to be moved along the SplinePath.

◆ SetInterpolationMode()

void Urho3D::SplinePath::SetInterpolationMode ( InterpolationMode  interpolationMode)

Set the Interpolation Mode.

◆ SetSpeed()

void Urho3D::SplinePath::SetSpeed ( float  speed)
inline

Set the movement Speed.


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