sprite.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
 
#pragma once
 
#include "target.h"
 
namespace libscratchcpp
{
 
class ISpriteHandler;
class IGraphicsEffect;
class SpritePrivate;

class LIBSCRATCHCPP_EXPORT Sprite
    : public Target
    , public std::enable_shared_from_this<Sprite>
{
    public:
        enum class RotationStyle
        {
            AllAround,
            LeftRight,
            DoNotRotate
        };
 
        Sprite();
        Sprite(const Sprite &) = delete;
 
        void setInterface(ISpriteHandler *newInterface);
        ISpriteHandler *getInterface() const; // NOTE: This can't be called interface because of... Microsoft... (it wouldn't compile on Windows)
 
        std::shared_ptr<Sprite> clone();
        void deleteClone();
 
        bool isClone() const;
 
        Sprite *cloneSprite() const;
        const std::vector<std::shared_ptr<Sprite>> &clones() const;
 
        bool visible() const;
        void setVisible(bool newVisible);
 
        double x() const;
        void setX(double newX);
 
        double y() const;
        void setY(double newY);
 
        void setPosition(double x, double y);
 
        bool dragging() const;
        void startDragging();
        void stopDragging();
        void dragToPosition(double x, double y);
 
        double size() const;
        void setSize(double newSize);
 
        void setCostumeIndex(int newCostumeIndex) override;
 
        int currentCostumeWidth() const override;
        int currentCostumeHeight() const override;
 
        double direction() const;
        void setDirection(double newDirection);
 
        bool draggable() const;
        void setDraggable(bool newDraggable);
 
        RotationStyle rotationStyle() const;
        std::string rotationStyleStr() const;
        void setRotationStyle(RotationStyle newRotationStyle);
        void setRotationStyle(const std::string &newRotationStyle);
        void setRotationStyle(const char *newRotationStyle);
 
        void setLayerOrder(int newLayerOrder) override;
 
        Rect boundingRect() const override;
        Rect fastBoundingRect() const override;
        void keepInFence(double newX, double newY, double *fencedX, double *fencedY) const;
 
        bool touchingPoint(double x, double y) const override;
        bool touchingColor(Rgb color) const override;
        bool touchingColor(Rgb color, Rgb mask) const override;
 
        void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
 
        void clearGraphicsEffects() override;
 
    private:
        Target *dataSource() const override;
        bool touchingClones(const std::vector<Sprite *> &clones) const override;
        void setXY(double x, double y);
 
        spimpl::unique_impl_ptr<SpritePrivate> impl;
};
 
} // namespace libscratchcpp