Sprite. More...

#include <Urho3D/Urho2D/Sprite2D.h>

Inheritance diagram for Urho3D::Sprite2D:
Collaboration diagram for Urho3D::Sprite2D:

Public Member Functions

 Sprite2D (Context *context)
virtual ~Sprite2D ()
virtual bool BeginLoad (Deserializer &source)
 Load resource from stream. May be called from a worker thread. Return true if successful.
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful.
void SetTexture (Texture2D *texture)
 Set texture.
void SetRectangle (const IntRect &rectangle)
 Set rectangle.
void SetHotSpot (const Vector2 &hotSpot)
 Set hot spot.
void SetOffset (const IntVector2 &offset)
 Set offset.
void SetTextureEdgeOffset (float offset)
 Set texture edge offset in pixels. This affects the left/right and top/bottom edges equally to prevent edge sampling artifacts. Default 0.
void SetSpriteSheet (SpriteSheet2D *spriteSheet)
 Set sprite sheet.
Texture2DGetTexture () const
 Return texture.
const IntRectGetRectangle () const
 Return rectangle.
const Vector2GetHotSpot () const
 Return hot spot.
const IntVector2GetOffset () const
 Return offset.
float GetTextureEdgeOffset () const
 Return texture edge offset.
SpriteSheet2DGetSpriteSheet () const
 Return sprite sheet.
bool GetDrawRectangle (Rect &rect, bool flipX=false, bool flipY=false) const
 Return draw rectangle.
bool GetDrawRectangle (Rect &rect, const Vector2 &hotSpot, bool flipX=false, bool flipY=false) const
 Return draw rectangle with custom hot spot.
bool GetTextureRectangle (Rect &rect, bool flipX=false, bool flipY=false) const
 Return texture rectangle.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
bool Load (Deserializer &source)
 Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
virtual bool Save (Serializer &dest) const
 Save resource. Return true if successful.
void SetName (const String &name)
 Set name.
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
void ResetUseTimer ()
 Reset last used timer.
void SetAsyncLoadState (AsyncLoadState newState)
 Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
const StringGetName () const
 Return name.
StringHash GetNameHash () const
 Return name hash.
unsigned GetMemoryUse () const
 Return memory use in bytes, possibly approximate.
unsigned GetUseTimer ()
 Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
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.
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 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 PODVector< 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. More...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
const VariantMapGetGlobalVars () const
 Return all global variables.
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
- 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.
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.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.
static ResourceRef SaveToResourceRef (Sprite2D *sprite)
 Save sprite to ResourceRef.
static Sprite2DLoadFromResourceRef (Object *object, const ResourceRef &value)
 Load sprite from ResourceRef.

Private Member Functions

 URHO3D_OBJECT (Sprite2D, Resource)

Private Attributes

SharedPtr< Texture2Dtexture_
IntRect rectangle_
Vector2 hotSpot_
 Hot spot.
IntVector2 offset_
 Offset (for trimmed sprite).
WeakPtr< SpriteSheet2DspriteSheet_
 Sprite sheet.
SharedPtr< Texture2DloadTexture_
 Texture used while loading.
float edgeOffset_
 Offset to fix texture edge bleeding.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
 Execution context.

Detailed Description

The documentation for this class was generated from the following files:
  • Source/Urho3D/Urho2D/Sprite2D.h
  • Source/Urho3D/Urho2D/Sprite2D.cpp