2014-03-10 14:04:58 +08:00
--------------------------------
-- @module Scale9Sprite
2015-03-16 14:53:18 +08:00
-- @extend Node,BlendProtocol
2014-08-22 19:25:33 +08:00
-- @parent_module ccui
2014-03-18 15:55:30 +08:00
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] disableCascadeColor
2014-03-10 14:04:58 +08:00
-- @param self
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-08-22 19:25:33 +08:00
--------------------------------
2014-10-08 17:53:11 +08:00
-- @overload self, cc.Sprite, rect_table, bool, vec2_table, size_table, rect_table
-- @overload self, cc.Sprite, rect_table, bool, rect_table
-- @function [parent=#Scale9Sprite] updateWithSprite
2014-08-22 19:25:33 +08:00
-- @param self
-- @param #cc.Sprite sprite
-- @param #rect_table rect
2014-09-02 13:45:07 +08:00
-- @param #bool rotated
2014-10-08 17:53:11 +08:00
-- @param #vec2_table offset
-- @param #size_table originalSize
2014-09-02 13:45:07 +08:00
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return bool#bool ret (return value: bool)
2014-10-08 17:53:11 +08:00
2014-08-22 19:25:33 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Returns the flag which indicates whether the widget is flipped horizontally or not.<br>
-- It only flips the texture of the widget, and not the texture of the widget's children.<br>
-- Also, flipping the texture doesn't alter the anchorPoint.<br>
-- If you want to flip the anchorPoint too, and/or to flip the children too use:<br>
-- widget->setScaleX(sprite->getScaleX() * -1);<br>
2015-01-21 09:36:21 +08:00
-- return true if the widget is flipped horizontally, false otherwise.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] isFlippedX
-- @param self
-- @return bool#bool ret (return value: bool)
2014-12-26 09:32:36 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Toggle 9-slice feature.<br>
-- If Scale9Sprite is 9-slice disabled, the Scale9Sprite will rendered as a normal sprite.<br>
-- param enabled True to enable 9-slice, false otherwise.
2014-12-26 09:32:36 +08:00
-- @function [parent=#Scale9Sprite] setScale9Enabled
-- @param self
-- @param #bool enabled
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-12-26 09:32:36 +08:00
2014-08-22 19:25:33 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Sets whether the widget should be flipped vertically or not.<br>
2015-03-26 10:44:28 +08:00
-- param flippedY true if the widget should be flipped vertically, false otherwise.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] setFlippedY
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #bool flippedY
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-08-22 19:25:33 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Sets whether the widget should be flipped horizontally or not.<br>
2015-03-26 10:44:28 +08:00
-- param flippedX true if the widget should be flipped horizontally, false otherwise.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] setFlippedX
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #bool flippedX
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-08-22 19:25:33 +08:00
--------------------------------
2014-12-26 09:32:36 +08:00
-- Creates and returns a new sprite object with the specified cap insets.<br>
-- You use this method to add cap insets to a sprite or to change the existing<br>
-- cap insets of a sprite. In both cases, you get back a new image and the<br>
-- original sprite remains untouched.<br>
2015-03-26 10:44:28 +08:00
-- param capInsets The values to use for the cap insets.<br>
-- return A Scale9Sprite instance.
2014-12-26 09:32:36 +08:00
-- @function [parent=#Scale9Sprite] resizableSpriteWithCapInsets
2014-08-22 19:25:33 +08:00
-- @param self
2014-12-26 09:32:36 +08:00
-- @param #rect_table capInsets
-- @return Scale9Sprite#Scale9Sprite ret (return value: ccui.Scale9Sprite)
2014-08-22 19:25:33 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] disableCascadeOpacity
-- @param self
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
2014-12-26 09:32:36 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- Change the state of 9-slice sprite.<br>
-- see `State`<br>
-- param state A enum value in State.<br>
2014-12-26 09:32:36 +08:00
-- since v3.4
-- @function [parent=#Scale9Sprite] setState
-- @param self
-- @param #int state
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-12-26 09:32:36 +08:00
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change the bottom sprite's cap inset.<br>
-- param bottomInset The values to use for the cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] setInsetBottom
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float bottomInset
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, string
-- @overload self, string, rect_table
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] initWithSpriteFrameName
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #string spriteFrameName
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
2014-08-22 19:25:33 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Get the original no 9-sliced sprite<br>
-- return A sprite instance.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] getSprite
-- @param self
-- @return Sprite#Sprite ret (return value: cc.Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change the top sprite's cap inset.<br>
-- param topInset The values to use for the cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] setInsetTop
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float topInset
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-08-22 19:25:33 +08:00
-- @overload self, cc.Sprite, rect_table, bool, rect_table
-- @overload self
-- @overload self, cc.Sprite, rect_table, rect_table
2014-10-08 17:53:11 +08:00
-- @overload self, cc.Sprite, rect_table, bool, vec2_table, size_table, rect_table
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] init
2014-03-10 14:04:58 +08:00
-- @param self
2014-08-22 19:25:33 +08:00
-- @param #cc.Sprite sprite
-- @param #rect_table rect
2014-09-02 13:45:07 +08:00
-- @param #bool rotated
2014-10-08 17:53:11 +08:00
-- @param #vec2_table offset
-- @param #size_table originalSize
2014-09-02 13:45:07 +08:00
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return bool#bool ret (return value: bool)
2014-08-22 19:25:33 +08:00
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change the prefered size of Scale9Sprite.<br>
-- param size A delimitation zone.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] setPreferredSize
-- @param self
-- @param #size_table size
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change inner sprite's sprite frame.<br>
-- param spriteFrame A sprite frame pointer.<br>
-- param capInsets The values to use for the cap insets.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] setSpriteFrame
2014-03-10 14:04:58 +08:00
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #cc.SpriteFrame spriteFrame
2014-10-08 17:53:11 +08:00
-- @param #rect_table capInsets
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-08-22 19:25:33 +08:00
2015-03-16 14:53:18 +08:00
--------------------------------
-- Returns the blending function that is currently being used.<br>
-- return A BlendFunc structure with source and destination factor which specified pixel arithmetic.<br>
-- js NA<br>
-- lua NA
-- @function [parent=#Scale9Sprite] getBlendFunc
-- @param self
-- @return BlendFunc#BlendFunc ret (return value: cc.BlendFunc)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the bottom sprite's cap inset.<br>
-- return The bottom sprite's cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] getInsetBottom
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the Scale9Sprite's prefered size.<br>
-- return Scale9Sprite's cap inset.
2014-12-26 09:32:36 +08:00
-- @function [parent=#Scale9Sprite] getCapInsets
2014-03-10 14:04:58 +08:00
-- @param self
2014-12-26 09:32:36 +08:00
-- @return rect_table#rect_table ret (return value: rect_table)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query whether the Scale9Sprite is enable 9-slice or not.<br>
-- return True if 9-slice is enabled, false otherwise.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] isScale9Enabled
2014-03-10 14:04:58 +08:00
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the right sprite's cap inset.<br>
-- return The right sprite's cap inset.
2014-12-26 09:32:36 +08:00
-- @function [parent=#Scale9Sprite] getInsetRight
2014-03-10 14:04:58 +08:00
-- @param self
2014-12-26 09:32:36 +08:00
-- @return float#float ret (return value: float)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the sprite's original size.<br>
-- return Sprite size.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] getOriginalSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, string, rect_table
-- @overload self, string, rect_table, rect_table
-- @overload self, rect_table, string
-- @overload self, string
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] initWithFile
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #string file
2014-03-10 14:04:58 +08:00
-- @param #rect_table rect
2014-09-02 13:45:07 +08:00
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
2015-03-16 14:53:18 +08:00
--------------------------------
-- Sets the source blending function.<br>
2015-03-27 00:17:35 +08:00
-- param blendFunc A structure with source and destination factor to specify pixel arithmetic. e.g. {GL_ONE, GL_ONE}, {GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA}.<br>
2015-03-16 14:53:18 +08:00
-- js NA<br>
-- lua NA
-- @function [parent=#Scale9Sprite] setBlendFunc
-- @param self
-- @param #cc.BlendFunc blendFunc
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the top sprite's cap inset.<br>
-- return The top sprite's cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] getInsetTop
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change the left sprite's cap inset.<br>
-- param leftInset The values to use for the cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] setInsetLeft
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float leftInset
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, cc.SpriteFrame
-- @overload self, cc.SpriteFrame, rect_table
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] initWithSpriteFrame
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #cc.SpriteFrame spriteFrame
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the Scale9Sprite's prefered size.<br>
-- return Scale9Sprite's prefered size.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] getPreferredSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change the cap inset size.<br>
-- param rect A delimitation zone.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] setCapInsets
-- @param self
-- @param #rect_table rect
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
2014-08-22 19:25:33 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- Return the flag which indicates whether the widget is flipped vertically or not.<br>
-- It only flips the texture of the widget, and not the texture of the widget's children.<br>
-- Also, flipping the texture doesn't alter the anchorPoint.<br>
-- If you want to flip the anchorPoint too, and/or to flip the children too use:<br>
-- widget->setScaleY(widget->getScaleY() * -1);<br>
-- return true if the widget is flipped vertically, flase otherwise.
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] isFlippedY
-- @param self
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Query the left sprite's cap inset.<br>
-- return The left sprite's cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] getInsetLeft
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
2015-03-26 10:44:28 +08:00
-- brief Change the right sprite's cap inset.<br>
-- param rightInset The values to use for the cap inset.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] setInsetRight
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #float rightInset
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, string, rect_table, rect_table
-- @overload self
-- @overload self, rect_table, string
-- @overload self, string, rect_table
-- @overload self, string
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] create
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #string file
2014-03-10 14:04:58 +08:00
-- @param #rect_table rect
2014-09-02 13:45:07 +08:00
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return Scale9Sprite#Scale9Sprite ret (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, string, rect_table
-- @overload self, string
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] createWithSpriteFrameName
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #string spriteFrameName
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return Scale9Sprite#Scale9Sprite ret (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, cc.SpriteFrame, rect_table
-- @overload self, cc.SpriteFrame
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] createWithSpriteFrame
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #cc.SpriteFrame spriteFrame
-- @param #rect_table capInsets
2014-10-17 22:56:22 +08:00
-- @return Scale9Sprite#Scale9Sprite ret (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
2014-03-18 15:55:30 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] setAnchorPoint
2014-03-18 15:55:30 +08:00
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #vec2_table anchorPoint
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-18 15:55:30 +08:00
2014-11-09 23:33:08 +08:00
--------------------------------
--
-- @function [parent=#Scale9Sprite] setScaleY
-- @param self
-- @param #float scaleY
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-11-09 23:33:08 +08:00
--------------------------------
--
-- @function [parent=#Scale9Sprite] setScaleX
-- @param self
-- @param #float scaleX
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-11-09 23:33:08 +08:00
--------------------------------
--
-- @function [parent=#Scale9Sprite] getScaleY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
--
-- @function [parent=#Scale9Sprite] getScaleX
-- @param self
-- @return float#float ret (return value: float)
2014-03-18 15:55:30 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] updateDisplayedOpacity
2014-03-18 15:55:30 +08:00
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #unsigned char parentOpacity
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-18 15:55:30 +08:00
2015-02-27 11:54:42 +08:00
--------------------------------
--
-- @function [parent=#Scale9Sprite] setCameraMask
-- @param self
-- @param #unsigned short mask
-- @param #bool applyChildren
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-18 15:55:30 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-08-22 19:25:33 +08:00
-- @function [parent=#Scale9Sprite] cleanup
2014-03-18 15:55:30 +08:00
-- @param self
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-18 15:55:30 +08:00
2014-11-09 23:33:08 +08:00
--------------------------------
-- @overload self, float, float
-- @overload self, float
-- @function [parent=#Scale9Sprite] setScale
-- @param self
2015-01-21 09:36:21 +08:00
-- @param #float scaleX
-- @param #float scaleY
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-11-09 23:33:08 +08:00
2014-03-18 15:55:30 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-18 15:55:30 +08:00
-- @function [parent=#Scale9Sprite] updateDisplayedColor
-- @param self
2014-09-02 13:45:07 +08:00
-- @param #color3b_table parentColor
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-18 15:55:30 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
--
2014-03-18 15:55:30 +08:00
-- @function [parent=#Scale9Sprite] setContentSize
-- @param self
-- @param #size_table size
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-18 15:55:30 +08:00
2014-11-09 23:33:08 +08:00
--------------------------------
--
-- @function [parent=#Scale9Sprite] getScale
-- @param self
-- @return float#float ret (return value: float)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-26 10:44:28 +08:00
-- Default constructor.<br>
2014-09-02 13:45:07 +08:00
-- js ctor
2014-03-10 14:04:58 +08:00
-- @function [parent=#Scale9Sprite] Scale9Sprite
-- @param self
2015-01-21 17:33:26 +08:00
-- @return Scale9Sprite#Scale9Sprite self (return value: ccui.Scale9Sprite)
2014-03-10 14:04:58 +08:00
return nil