class CCL::MultiSprite

Overview

A MultiSprite shows, hides and moves multiple sprites at once. More…

#include <multisprite.h>

class MultiSprite:
    public CCL::Object,
    public CCL::ISprite
{
public:
    // typedefs

    typedef LinkedList <ISprite*> SpriteList;

    // fields

     ISprite;

    // construction

    MultiSprite (UserControl* control);

    // methods

    DECLARE_CLASS (MultiSprite, Object);
    PROPERTY_FLAG (style, kCollectLayerUpdates, collectLayerUpdates) const;
    const SpriteList& getSprites () const;
    void addSprite (ISprite* sprite);
    void prependSprite (ISprite* sprite);
    void removeSprite (ISprite* sprite);
    void removeAll ();
    virtual RectRef CCL_API getSize () const;
    virtual tbool CCL_API isVisible () const;
    virtual void CCL_API show ();
    virtual void CCL_API hide ();
    virtual void CCL_API moveTo (PointRef position);
    virtual void CCL_API scrolled (PointRef delta);
    virtual void CCL_API refresh ();
    virtual void CCL_API takeOpacity (IDrawable* drawable);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum Options;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();

    virtual tresult CCL_API construct (
        IView* view,
        RectRef size = Rect (),
        IDrawable* drawable = nullptr,
        int options = 0
    ) = 0;

    virtual RectRef CCL_API getSize () const = 0;
    virtual IDrawable*CCL_API getDrawable () const = 0;
    virtual tbool CCL_API isVisible () const = 0;
    virtual void CCL_API show () = 0;
    virtual void CCL_API hide () = 0;
    virtual void CCL_API move (RectRef size) = 0;
    virtual void CCL_API moveTo (PointRef position) = 0;
    virtual void CCL_API scrolled (PointRef delta) = 0;
    virtual void CCL_API refresh () = 0;
    virtual void CCL_API takeOpacity (IDrawable* drawable) = 0;

Detailed Documentation

A MultiSprite shows, hides and moves multiple sprites at once.

Methods

virtual RectRef CCL_API getSize () const

calculates joined size of all sprites

virtual tbool CCL_API isVisible () const

Check if sprite is currently visible.

virtual void CCL_API show ()

Show sprite.

virtual void CCL_API hide ()

Hide sprite.

virtual void CCL_API moveTo (PointRef position)

Move sprite.

virtual void CCL_API scrolled (PointRef delta)

Inform sprite that is has been scrolled on screen.

virtual void CCL_API refresh ()

Inform sprite that the drawable has changed.

virtual void CCL_API takeOpacity (IDrawable* drawable)

Let drawable take opacity from its content, implemented only in certain sprite classes.