Rebel Fork Framework
Urho3D::Sprite2D Class Reference

Sprite. More...

#include <Urho3D/Urho2D/Sprite2D.h>

Inheritance diagram for Urho3D::Sprite2D:
Urho3D::Resource Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Sprite2D (Context *context)
 ~Sprite2D () override
bool BeginLoad (Deserializer &source) override
 Load resource from stream. May be called from a worker thread. Return true if successful.
bool EndLoad () override
 Finish resource loading. Always called from the main thread. Return true if successful.
void SetTexture (Texture2D *texture)
void SetRectangle (const IntRect &rectangle)
void SetHotSpot (const Vector2 &hotSpot)
void SetOffset (const IntVector2 &offset)
void SetTextureEdgeOffset (float offset)
void SetSpriteSheet (SpriteSheet2D *spriteSheet)
 Set sprite sheet.
Texture2DGetTexture () const
const IntRectGetRectangle () const
const Vector2GetHotSpot () const
const IntVector2GetOffset () const
float GetTextureEdgeOffset () const
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.
bool LoadFile (const FileIdentifier &fileName)
 Load resource from file.
virtual bool SaveFile (const FileIdentifier &fileName) const
 Save resource to file.
void SetName (const ea::string &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.
void SetAbsoluteFileName (const ea::string &fileName)
 Set absolute file name.
const ea::string & GetName () const
StringHash GetNameHash () const
 Return name hash.
unsigned GetMemoryUse () const
unsigned GetUseTimer ()
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
const ea::string & GetAbsoluteFileName () const
 Return absolute file name.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~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.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
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 ResourceRef SaveToResourceRef (Sprite2D *sprite)
 Save sprite to ResourceRef.
static Sprite2DLoadFromResourceRef (Object *object, const ResourceRef &value)
 Load sprite from ResourceRef.
- Static Public Member Functions inherited from Urho3D::Resource
static ResourceLoadFromCache (Context *context, StringHash type, const ea::string &name)
 Load resource by reference.
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

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
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

Member Function Documentation

◆ GetHotSpot()

const Vector2& Urho3D::Sprite2D::GetHotSpot ( ) const

Return hot spot.

◆ GetOffset()

const IntVector2& Urho3D::Sprite2D::GetOffset ( ) const

Return offset.

◆ GetRectangle()

const IntRect& Urho3D::Sprite2D::GetRectangle ( ) const

Return rectangle.

◆ GetTexture()

Texture2D* Urho3D::Sprite2D::GetTexture ( ) const

Return texture.

◆ GetTextureEdgeOffset()

float Urho3D::Sprite2D::GetTextureEdgeOffset ( ) const

Return texture edge offset.

◆ RegisterObject()

void Urho3D::Sprite2D::RegisterObject ( Context context)

Register object factory.

◆ SetHotSpot()

void Urho3D::Sprite2D::SetHotSpot ( const Vector2 hotSpot)

Set hot spot.

◆ SetOffset()

void Urho3D::Sprite2D::SetOffset ( const IntVector2 offset)

Set offset.

◆ SetRectangle()

void Urho3D::Sprite2D::SetRectangle ( const IntRect rectangle)

Set rectangle.

◆ SetTexture()

void Urho3D::Sprite2D::SetTexture ( Texture2D texture)

Set texture.

◆ SetTextureEdgeOffset()

void Urho3D::Sprite2D::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.

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