mirror of https://github.com/axmolengine/axmol.git
242 lines
8.0 KiB
C++
242 lines
8.0 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2008-2011 Ricardo Quesada
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
Copyright (c) 2011 Zynga Inc.
|
|
Copyright (c) 2013-2014 Chukong Technologies Inc.
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#ifndef __SPRITE_CCSPRITE_FRAME_H__
|
|
#define __SPRITE_CCSPRITE_FRAME_H__
|
|
|
|
#include "2d/CCNode.h"
|
|
#include "base/CCRef.h"
|
|
#include "math/CCGeometry.h"
|
|
|
|
NS_CC_BEGIN
|
|
|
|
class Texture2D;
|
|
|
|
/**
|
|
* @addtogroup _2d
|
|
* @{
|
|
*/
|
|
|
|
/** @class SpriteFrame
|
|
* @brief A SpriteFrame has:
|
|
- texture: A Texture2D that will be used by the Sprite
|
|
- rectangle: A rectangle of the texture
|
|
|
|
|
|
You can modify the frame of a Sprite by doing:
|
|
|
|
SpriteFrame *frame = SpriteFrame::frameWithTexture(texture, rect, offset);
|
|
sprite->setDisplayFrame(frame);
|
|
*/
|
|
class CC_DLL SpriteFrame : public Ref, public Clonable
|
|
{
|
|
public:
|
|
|
|
/** Create a SpriteFrame with a texture filename, rect in points.
|
|
It is assumed that the frame was not trimmed.
|
|
*
|
|
* @param filename Texture file name.
|
|
* @param rect A specified rect.
|
|
* @return An autoreleased SpriteFrame object.
|
|
*/
|
|
static SpriteFrame* create(const std::string& filename, const Rect& rect);
|
|
|
|
/** Create a SpriteFrame with a texture filename, rect, rotated, offset and originalSize in pixels.
|
|
The originalSize is the size in pixels of the frame before being trimmed.
|
|
*
|
|
* @param filename Texture filename
|
|
* @param rect A specified rect.
|
|
* @param rotated Is rotated if true.
|
|
* @param offset A specified offset.
|
|
* @param originalSize A specified original size.
|
|
* @return An autoreleased SpriteFrame object.
|
|
*/
|
|
static SpriteFrame* create(const std::string& filename, const Rect& rect, bool rotated, const Vec2& offset, const Size& originalSize);
|
|
|
|
/** Create a SpriteFrame with a texture, rect in points.
|
|
It is assumed that the frame was not trimmed.
|
|
* @param pobTexture The texture pointer.
|
|
* @param rect A specified rect.
|
|
* @return An autoreleased SpriteFrame object.
|
|
*/
|
|
static SpriteFrame* createWithTexture(Texture2D* pobTexture, const Rect& rect);
|
|
|
|
/** Create a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.
|
|
The originalSize is the size in points of the frame before being trimmed.
|
|
* @param pobTexture The texture pointer.
|
|
* @param rect A specified rect.
|
|
* @param rotated Is rotated if true.
|
|
* @param offset A specified offset.
|
|
* @param originalSize A specified original size.
|
|
* @return An autoreleased SpriteFrame object.
|
|
*/
|
|
static SpriteFrame* createWithTexture(Texture2D* pobTexture, const Rect& rect, bool rotated, const Vec2& offset, const Size& originalSize);
|
|
|
|
// attributes
|
|
/** Get rect of the sprite frame.
|
|
*
|
|
* @return The rect of the sprite frame, in pixels.
|
|
*/
|
|
inline const Rect& getRectInPixels() const { return _rectInPixels; }
|
|
/** Set rect of the sprite frame.
|
|
*
|
|
* @param rectInPixels The rect of the sprite frame, in pixels.
|
|
*/
|
|
void setRectInPixels(const Rect& rectInPixels);
|
|
|
|
/**Is the sprite frame rotated or not.
|
|
*
|
|
* @return Is rotated if true.
|
|
*/
|
|
inline bool isRotated() const { return _rotated; }
|
|
/** Set rotated of the sprite frame.
|
|
*
|
|
* @param rotated Rotated the sprite frame if true.
|
|
*/
|
|
inline void setRotated(bool rotated) { _rotated = rotated; }
|
|
|
|
/** Get rect of the frame.
|
|
*
|
|
* @return The rect of the sprite frame.
|
|
*/
|
|
inline const Rect& getRect() const { return _rect; }
|
|
/** Set rect of the frame.
|
|
*
|
|
* @param rect The rect of the sprite.
|
|
*/
|
|
void setRect(const Rect& rect);
|
|
|
|
/** Get offset of the frame.
|
|
*
|
|
* @return The offset of the sprite frame, in pixels.
|
|
*/
|
|
const Vec2& getOffsetInPixels() const;
|
|
/** Set offset of the frame.
|
|
*
|
|
* @param offsetInPixels The offset of the sprite frame, in pixels.
|
|
*/
|
|
void setOffsetInPixels(const Vec2& offsetInPixels);
|
|
|
|
/** Get original size of the trimmed image.
|
|
*
|
|
* @return The original size of the trimmed image, in pixels.
|
|
*/
|
|
inline const Size& getOriginalSizeInPixels() const { return _originalSizeInPixels; }
|
|
/** Set original size of the trimmed image.
|
|
*
|
|
* @param sizeInPixels The original size of the trimmed image, in pixels.
|
|
*/
|
|
inline void setOriginalSizeInPixels(const Size& sizeInPixels) { _originalSizeInPixels = sizeInPixels; }
|
|
|
|
/** Get original size of the trimmed image.
|
|
*
|
|
* @return The original size of the trimmed image.
|
|
*/
|
|
inline const Size& getOriginalSize() const { return _originalSize; }
|
|
/** Set original size of the trimmed image.
|
|
*
|
|
* @param sizeInPixels The original size of the trimmed image.
|
|
*/
|
|
inline void setOriginalSize(const Size& sizeInPixels) { _originalSize = sizeInPixels; }
|
|
|
|
/** Get texture of the frame.
|
|
*
|
|
* @return The texture of the sprite frame.
|
|
*/
|
|
Texture2D* getTexture();
|
|
/** Set texture of the frame, the texture is retained.
|
|
*
|
|
* @param pobTexture The texture of the sprite frame.
|
|
*/
|
|
void setTexture(Texture2D* pobTexture);
|
|
|
|
/** Get offset of the frame.
|
|
*
|
|
* @return The offset of the sprite frame.
|
|
*/
|
|
const Vec2& getOffset() const;
|
|
/** Set offset of the frame.
|
|
*
|
|
* @param offsets The offset of the sprite frame.
|
|
*/
|
|
void setOffset(const Vec2& offsets);
|
|
|
|
// Overrides
|
|
virtual SpriteFrame *clone() const override;
|
|
|
|
CC_CONSTRUCTOR_ACCESS:
|
|
/**
|
|
* @lua NA
|
|
*/
|
|
SpriteFrame();
|
|
|
|
/**
|
|
* @lua NA
|
|
*/
|
|
virtual ~SpriteFrame();
|
|
|
|
/** Initializes a SpriteFrame with a texture, rect in points.
|
|
It is assumed that the frame was not trimmed.
|
|
*/
|
|
bool initWithTexture(Texture2D* pobTexture, const Rect& rect);
|
|
|
|
/** Initializes a SpriteFrame with a texture filename, rect in points;
|
|
It is assumed that the frame was not trimmed.
|
|
*/
|
|
bool initWithTextureFilename(const std::string& filename, const Rect& rect);
|
|
|
|
/** Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.
|
|
The originalSize is the size in points of the frame before being trimmed.
|
|
*/
|
|
bool initWithTexture(Texture2D* pobTexture, const Rect& rect, bool rotated, const Vec2& offset, const Size& originalSize);
|
|
|
|
/** Initializes a SpriteFrame with a texture, rect, rotated, offset and originalSize in pixels.
|
|
The originalSize is the size in pixels of the frame before being trimmed.
|
|
|
|
@since v1.1
|
|
*/
|
|
bool initWithTextureFilename(const std::string& filename, const Rect& rect, bool rotated, const Vec2& offset, const Size& originalSize);
|
|
|
|
protected:
|
|
Vec2 _offset;
|
|
Size _originalSize;
|
|
Rect _rectInPixels;
|
|
bool _rotated;
|
|
Rect _rect;
|
|
Vec2 _offsetInPixels;
|
|
Size _originalSizeInPixels;
|
|
Texture2D *_texture;
|
|
std::string _textureFilename;
|
|
};
|
|
|
|
// end of _2d group
|
|
/// @}
|
|
|
|
NS_CC_END
|
|
|
|
#endif //__SPRITE_CCSPRITE_FRAME_H__
|