|
|
| ListView () |
| | Default constructor @js ctor @lua new.
|
| |
|
| ~ListView () override |
| | Default destructor @js NA @lua NA.
|
| |
| void | setItemModel (Widget *model) |
| | Set an item model for listview.
|
| |
|
void | pushBackDefaultItem () |
| | Insert a default item(create by a cloned model) at the end of the listview.
|
| |
| void | insertDefaultItem (ssize_t index) |
| | Insert a default item(create by cloning model) into listview at a give index.
|
| |
| void | pushBackCustomItem (Widget *item) |
| | Insert a custom item into the end of ListView.
|
| |
| void | insertCustomItem (Widget *item, ssize_t index) |
| | Insert a custom widget into ListView at a given index.
|
| |
|
void | removeLastItem () |
| | Removes the last item of ListView.
|
| |
| void | removeItem (ssize_t index) |
| | Remove an item at given index.
|
| |
|
void | removeAllItems () |
| | Remove all items in current ListView.
|
| |
| Widget * | getItem (ssize_t index) const |
| | Return an item at a given index.
|
| |
| Vector< Widget * > & | getItems () |
| | Return all items in a ListView.
|
| |
| ssize_t | getIndex (Widget *item) const |
| | Return the index of specified widget.
|
| |
| void | setGravity (Gravity gravity) |
| | Set the gravity of ListView.
|
| |
| void | setMagneticType (MagneticType magneticType) |
| | Set magnetic type of ListView.
|
| |
|
MagneticType | getMagneticType () const |
| | Get magnetic type of ListView.
|
| |
|
void | setMagneticAllowedOutOfBoundary (bool magneticAllowedOutOfBoundary) |
| | Set magnetic allowed out of boundary.
|
| |
|
bool | getMagneticAllowedOutOfBoundary () const |
| | Query whether the magnetic out of boundary is allowed.
|
| |
| void | setItemsMargin (float margin) |
| | Set the margin between each item in ListView.
|
| |
| float | getItemsMargin () const |
| | Query margin between each item in ListView.
|
| |
| void | setPadding (float l, float t, float r, float b) |
| | Change padding with left, top, right, and bottom padding.
|
| |
| void | setLeftPadding (float l) |
| | Change padding with left padding.
|
| |
| void | setTopPadding (float t) |
| | Change padding with top padding.
|
| |
| void | setRightPadding (float r) |
| | Change padding with right padding.
|
| |
| void | setBottomPadding (float b) |
| | Change padding with bottom padding.
|
| |
| float | getLeftPadding () const |
| | Get the left padding in ListView.
|
| |
| float | getTopPadding () const |
| | Get the top padding in ListView.
|
| |
| float | getRightPadding () const |
| | Get the right padding in ListView.
|
| |
| float | getBottomPadding () const |
| | Get the bottom padding in ListView.
|
| |
|
void | requestDoLayout () override |
| | request to refresh widget layout
|
| |
| void | addChild (Node *child) override |
| | Adds a child to the container with z-order as 0.
|
| |
| void | addChild (Node *child, int localZOrder) override |
| | Adds a child to the container with a local z-order.
|
| |
| void | addChild (Node *child, int zOrder, int tag) override |
| | Adds a child to the container with z order and tag.
|
| |
| void | addChild (Node *child, int zOrder, std::string_view name) override |
| | Adds a child to the container with z order and tag.
|
| |
| void | removeAllChildren () override |
| | Removes all children from the container with a cleanup.
|
| |
| void | removeAllChildrenWithCleanup (bool cleanup) override |
| | Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.
|
| |
| void | removeChild (Node *child, bool cleanup=true) override |
| | Removes a child from the container.
|
| |
| Widget * | getClosestItemToPosition (const Vec2 &targetPosition, const Vec2 &itemAnchorPoint) const |
| | Query the closest item to a specific position in inner container.
|
| |
| Widget * | getClosestItemToPositionInCurrentView (const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint) const |
| | Query the closest item to a specific position in current view.
|
| |
| Widget * | getCenterItemInCurrentView () const |
| | Query the center item.
|
| |
| Widget * | getLeftmostItemInCurrentView () const |
| | Query the leftmost item in horizontal list.
|
| |
| Widget * | getRightmostItemInCurrentView () const |
| | Query the rightmost item in horizontal list.
|
| |
| Widget * | getTopmostItemInCurrentView () const |
| | Query the topmost item in horizontal list.
|
| |
| Widget * | getBottommostItemInCurrentView () const |
| | Query the bottommost item in horizontal list.
|
| |
|
void | jumpToBottom () override |
| | Override functions.
|
| |
|
void | jumpToTop () override |
| | Move inner container to top boundary of scrollview.
|
| |
|
void | jumpToLeft () override |
| | Move inner container to left boundary of scrollview.
|
| |
|
void | jumpToRight () override |
| | Move inner container to right boundary of scrollview.
|
| |
|
void | jumpToTopLeft () override |
| | Move inner container to top and left boundary of scrollview.
|
| |
|
void | jumpToTopRight () override |
| | Move inner container to top and right boundary of scrollview.
|
| |
|
void | jumpToBottomLeft () override |
| | Move inner container to bottom and left boundary of scrollview.
|
| |
|
void | jumpToBottomRight () override |
| | Move inner container to bottom and right boundary of scrollview.
|
| |
| void | jumpToPercentVertical (float percent) override |
| | Move inner container to vertical percent position of scrollview.
|
| |
| void | jumpToPercentHorizontal (float percent) override |
| | Move inner container to horizontal percent position of scrollview.
|
| |
| void | jumpToPercentBothDirection (const Vec2 &percent) override |
| | Move inner container to both direction percent position of scrollview.
|
| |
| void | jumpToItem (ssize_t itemIndex, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint) |
| | Jump to specific item.
|
| |
| void | scrollToItem (ssize_t itemIndex, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint) |
| | Scroll to specific item.
|
| |
| void | scrollToItem (ssize_t itemIndex, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint, float timeInSec) |
| | Scroll to specific item.
|
| |
| ssize_t | getCurSelectedIndex () const |
| | Query current selected widget's index.
|
| |
| void | setCurSelectedIndex (int itemIndex) |
| | Set current selected widget's index and call TouchEventType::ENDED event.
|
| |
| void | addEventListener (const ccListViewCallback &callback) |
| | Add an event click callback to ListView, then one item of Listview is clicked, the callback will be called.
|
| |
| void | setDirection (Direction dir) override |
| | Changes scroll direction of scrollview.
|
| |
|
std::string | getDescription () const override |
| | Returns the "class name" of widget.
|
| |
|
| ScrollView () |
| | Default constructor @js ctor @lua new.
|
| |
|
| ~ScrollView () override |
| | Default destructor @js NA @lua NA.
|
| |
| Direction | getDirection () const |
| | Query scroll direction of scrollview.
|
| |
| Layout * | getInnerContainer () const |
| | Get inner container of scrollview.
|
| |
|
virtual void | stopScroll () |
| | Immediately stops inner container scroll (auto scrolling is not affected).
|
| |
|
virtual void | stopAutoScroll () |
| | Immediately stops inner container scroll initiated by any of the "scrollTo*" member functions.
|
| |
|
virtual void | stopOverallScroll () |
| | Immediately stops inner container scroll if any.
|
| |
| virtual void | scrollToBottom (float timeInSec, bool attenuated) |
| | Scroll inner container to bottom boundary of scrollview.
|
| |
| virtual void | scrollToTop (float timeInSec, bool attenuated) |
| | Scroll inner container to top boundary of scrollview.
|
| |
| virtual void | scrollToLeft (float timeInSec, bool attenuated) |
| | Scroll inner container to left boundary of scrollview.
|
| |
| virtual void | scrollToRight (float timeInSec, bool attenuated) |
| | Scroll inner container to right boundary of scrollview.
|
| |
| virtual void | scrollToTopLeft (float timeInSec, bool attenuated) |
| | Scroll inner container to top and left boundary of scrollview.
|
| |
| virtual void | scrollToTopRight (float timeInSec, bool attenuated) |
| | Scroll inner container to top and right boundary of scrollview.
|
| |
| virtual void | scrollToBottomLeft (float timeInSec, bool attenuated) |
| | Scroll inner container to bottom and left boundary of scrollview.
|
| |
| virtual void | scrollToBottomRight (float timeInSec, bool attenuated) |
| | Scroll inner container to bottom and right boundary of scrollview.
|
| |
| virtual void | scrollToPercentVertical (float percent, float timeInSec, bool attenuated) |
| | Scroll inner container to vertical percent position of scrollview.
|
| |
| virtual void | scrollToPercentHorizontal (float percent, float timeInSec, bool attenuated) |
| | Scroll inner container to horizontal percent position of scrollview.
|
| |
| virtual void | scrollToPercentBothDirection (const Vec2 &percent, float timeInSec, bool attenuated) |
| | Scroll inner container to both direction percent position of scrollview.
|
| |
| float | getScrolledPercentVertical () const |
| |
| float | getScrolledPercentHorizontal () const |
| |
| Vec2 | getScrolledPercentBothDirection () const |
| |
| void | setInnerContainerSize (const Vec2 &size) |
| | Change inner container size of scrollview.
|
| |
| const Vec2 & | getInnerContainerSize () const |
| | Get inner container size of scrollview.
|
| |
| void | setInnerContainerPosition (const Vec2 &pos) |
| | Set inner container position.
|
| |
| const Vec2 & | getInnerContainerPosition () const |
| | Get inner container position.
|
| |
| void | addChild (Node *child) override |
| | Adds a child to the container with z-order as 0.
|
| |
| void | addChild (Node *child, int localZOrder) override |
| | Adds a child to the container with a local z-order.
|
| |
| void | addChild (Node *child, int localZOrder, int tag) override |
| | Adds a child to the container with z order and tag.
|
| |
| void | addChild (Node *child, int localZOrder, std::string_view name) override |
| | Adds a child to the container with z order and tag.
|
| |
| void | removeAllChildren () override |
| | Removes all children from the container with a cleanup.
|
| |
| void | removeAllChildrenWithCleanup (bool cleanup) override |
| | Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.
|
| |
| void | removeChild (Node *child, bool cleanup=true) override |
| | Removes a child from the container.
|
| |
| Vector< Node * > & | getChildren () override |
| | Returns the array of the node's children.
|
| |
| ssize_t | getChildrenCount () const override |
| | Returns the amount of children.
|
| |
| Node * | getChildByTag (int tag) const override |
| | Gets a child from the container with its tag.
|
| |
| Node * | getChildByName (std::string_view name) const override |
| | Gets a child from the container with its name.
|
| |
| bool | onTouchBegan (Touch *touch, Event *unusedEvent) override |
| | A callback which will be called when touch began event is issued.
|
| |
| void | onTouchMoved (Touch *touch, Event *unusedEvent) override |
| | A callback which will be called when touch moved event is issued.
|
| |
| void | onTouchEnded (Touch *touch, Event *unusedEvent) override |
| | A callback which will be called when touch ended event is issued.
|
| |
| void | onTouchCancelled (Touch *touch, Event *unusedEvent) override |
| | A callback which will be called when touch cancelled event is issued.
|
| |
| void | update (float dt) override |
| | Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
|
| |
| void | setBounceEnabled (bool enabled) |
| | Toggle bounce enabled when scroll to the edge.
|
| |
| bool | isBounceEnabled () const |
| | Query bounce state.
|
| |
| void | setInertiaScrollEnabled (bool enabled) |
| | Toggle whether enable scroll inertia while scrolling.
|
| |
| bool | isInertiaScrollEnabled () const |
| | Query inertia scroll state.
|
| |
| void | setScrollBarEnabled (bool enabled) |
| | Toggle scroll bar enabled.
|
| |
| bool | isScrollBarEnabled () const |
| | Query scroll bar state.
|
| |
| void | setScrollBarPositionFromCorner (const Vec2 &positionFromCorner) |
| | Set the scroll bar positions from the left-bottom corner (horizontal) and right-top corner (vertical).
|
| |
| void | setScrollBarPositionFromCornerForVertical (const Vec2 &positionFromCorner) |
| | Set the vertical scroll bar position from right-top corner.
|
| |
| Vec2 | getScrollBarPositionFromCornerForVertical () const |
| | Get the vertical scroll bar's position from right-top corner.
|
| |
| void | setScrollBarPositionFromCornerForHorizontal (const Vec2 &positionFromCorner) |
| | Set the horizontal scroll bar position from left-bottom corner.
|
| |
| Vec2 | getScrollBarPositionFromCornerForHorizontal () const |
| | Get the horizontal scroll bar's position from right-top corner.
|
| |
| void | setScrollBarWidth (float width) |
| | Set the scroll bar's width.
|
| |
| float | getScrollBarWidth () const |
| | Get the scroll bar's width.
|
| |
| void | setScrollBarColor (const Color3B &color) |
| | Set the scroll bar's color.
|
| |
| const Color3B & | getScrollBarColor () const |
| | Get the scroll bar's color.
|
| |
| void | setScrollBarOpacity (uint8_t opacity) |
| | Set the scroll bar's opacity.
|
| |
| uint8_t | getScrollBarOpacity () const |
| | Get the scroll bar's opacity.
|
| |
| void | setScrollBarAutoHideEnabled (bool autoHideEnabled) |
| | Set scroll bar auto hide state.
|
| |
| bool | isScrollBarAutoHideEnabled () const |
| | Query scroll bar auto hide state.
|
| |
| void | setScrollBarAutoHideTime (float autoHideTime) |
| | Set scroll bar auto hide time.
|
| |
| float | getScrollBarAutoHideTime () const |
| | Get the scroll bar's auto hide time.
|
| |
| void | setTouchTotalTimeThreshold (float touchTotalTimeThreshold) |
| | Set the touch total time threshold.
|
| |
| float | getTouchTotalTimeThreshold () const |
| | Get the touch total time threshold.
|
| |
| void | setLayoutType (Type type) override |
| | Set layout type for scrollview.
|
| |
| Type | getLayoutType () const override |
| | Get the layout type for scrollview.
|
| |
|
std::string | getDescription () const override |
| | Return the "class name" of widget.
|
| |
|
void | onEnter () override |
| | @lua NA
|
| |
|
void | onExit () override |
| | @lua NA
|
| |
| Widget * | findNextFocusedWidget (FocusDirection direction, Widget *current) override |
| | When a widget is in a layout, you could call this method to get the next focused widget within a specified direction.
|
| |
| void | setScrollDuration (float time) |
| | Set the time in seconds to scroll between items.
|
| |
| float | getScrollDuration () const |
| | Get the time in seconds to scroll between items.
|
| |
| bool | isScrolling () const |
| |
| bool | isAutoScrolling () const |
| |
| void | scrollToItem (Node *item, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint) |
| | Scroll to specific item.
|
| |
| void | scrollToItem (Node *item, const Vec2 &positionRatioInView, const Vec2 &itemAnchorPoint, float timeInSec) |
| | Scroll to specific item.
|
| |
|
| Layout () |
| | Default constructor @js ctor @lua new.
|
| |
|
virtual | ~Layout () |
| | Default destructor @js NA @lua NA.
|
| |
| void | setBackGroundImage (std::string_view fileName, TextureResType texType=TextureResType::LOCAL) |
| | Sets a background image for layout.
|
| |
| void | setBackGroundImageCapInsets (const Rect &capInsets) |
| | Sets a background image capinsets for layout, it only affects the scale9 enabled background image.
|
| |
| const Rect & | getBackGroundImageCapInsets () const |
| | Query background image's capInsets size.
|
| |
| void | setBackGroundColorType (BackGroundColorType type) |
| | Sets Color Type for layout's background.
|
| |
| BackGroundColorType | getBackGroundColorType () const |
| | Query the layout's background color type.
|
| |
| void | setBackGroundImageScale9Enabled (bool enabled) |
| | Enable background image scale9 rendering.
|
| |
| bool | isBackGroundImageScale9Enabled () const |
| | Query background image scale9 enable status.
|
| |
| void | setBackGroundColor (const Color3B &color) |
| | Set background color for layout The color only applies to layout when it's color type is BackGroundColorType::SOLIDE.
|
| |
| const Color3B & | getBackGroundColor () const |
| | Query the layout's background color.
|
| |
| void | setBackGroundColor (const Color3B &startColor, const Color3B &endColor) |
| | Set start and end background color for layout.
|
| |
| const Color3B & | getBackGroundStartColor () const |
| | Get the gradient background start color.
|
| |
| const Color3B & | getBackGroundEndColor () const |
| | Get the gradient background end color.
|
| |
| void | setBackGroundColorOpacity (uint8_t opacity) |
| | Sets background color opacity of layout.
|
| |
| uint8_t | getBackGroundColorOpacity () const |
| | Get the layout's background color opacity.
|
| |
| void | setBackGroundColorVector (const Vec2 &vector) |
| | Sets background color vector for layout.
|
| |
| const Vec2 & | getBackGroundColorVector () const |
| | Get the layout's background color vector.
|
| |
| void | setBackGroundImageColor (const Color3B &color) |
| | Set layout's background image color.
|
| |
| void | setBackGroundImageOpacity (uint8_t opacity) |
| | Set opacity of background image.
|
| |
| const Color3B & | getBackGroundImageColor () const |
| | Get color of layout's background image.
|
| |
| uint8_t | getBackGroundImageOpacity () const |
| | Get the opacity of layout's background image.
|
| |
|
void | removeBackGroundImage () |
| | Remove the background image of layout.
|
| |
| const Vec2 & | getBackGroundImageTextureSize () const |
| | Gets background image texture size.
|
| |
| virtual void | setClippingEnabled (bool enabled) |
| | Toggle layout clipping.
|
| |
| void | setClippingType (ClippingType type) |
| | Change the clipping type of layout.
|
| |
| ClippingType | getClippingType () const |
| |
| virtual bool | isClippingEnabled () const |
| | Gets if layout is clipping enabled.
|
| |
|
virtual void | visit (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override |
| | @js NA
|
| |
|
virtual void | forceDoLayout () |
| | force refresh widget layout
|
| |
| virtual void | setGlobalZOrder (float globalZOrder) override |
| | Defines the order in which the nodes are renderer.
|
| |
| void | setLoopFocus (bool loop) |
| | If a layout is loop focused which means that the focus movement will be inside the layout.
|
| |
| bool | isLoopFocus () const |
| |
| void | setPassFocusToChild (bool pass) |
| |
| bool | isPassFocusToChild () const |
| |
| virtual void | setCameraMask (unsigned short mask, bool applyChildren=true) override |
| | Override function.
|
| |
|
| Widget () |
| | Default constructor @js ctor @lua new.
|
| |
|
virtual | ~Widget () |
| | Default destructor @js NA @lua NA.
|
| |
| virtual void | setEnabled (bool enabled) |
| | Sets whether the widget is enabled.
|
| |
| bool | isEnabled () const |
| | Determines if the widget is enabled or not.
|
| |
| void | setBright (bool bright) |
| | Sets whether the widget is bright.
|
| |
| bool | isBright () const |
| | Determines if the widget is bright.
|
| |
| virtual void | setTouchEnabled (bool enabled) |
| | Sets whether the widget is touch enabled.
|
| |
| void | setBrightStyle (BrightStyle style) |
| | To set the bright style of widget.
|
| |
| bool | isTouchEnabled () const |
| | Determines if the widget is touch enabled.
|
| |
| bool | isHighlighted () const |
| | Determines if the widget is highlighted.
|
| |
| void | setHighlighted (bool highlight) |
| | Sets whether the widget is highlighted.
|
| |
| float | getLeftBoundary () const |
| | Gets the left boundary position of this widget in parent's coordination system.
|
| |
| float | getBottomBoundary () const |
| | Gets the bottom boundary position of this widget in parent's coordination system.
|
| |
| float | getRightBoundary () const |
| | Gets the right boundary position of this widget in parent's coordination system.
|
| |
| float | getTopBoundary () const |
| | Gets the top boundary position of this widget in parent's coordination system.
|
| |
| void | addTouchEventListener (const ccWidgetTouchCallback &callback) |
| | Set a callback to touch vent listener.
|
| |
| void | addClickEventListener (const ccWidgetClickCallback &callback) |
| | Set a click event handler to the widget.
|
| |
| virtual void | addCCSEventListener (const ccWidgetEventCallback &callback) |
| | Set a event handler to the widget in order to use cocostudio editor and framework.
|
| |
| virtual void | setPosition (const Vec2 &pos) override |
| | Changes the position (x,y) of the widget in OpenGL coordinates.
|
| |
| void | setPositionNormalized (const Vec2 &position) override |
| | Sets the position (x,y) using values between 0 and 1.
|
| |
| void | setPositionPercent (const Vec2 &percent) |
| | Set the percent(x,y) of the widget in OpenGL coordinates.
|
| |
| const Vec2 & | getPositionPercent () |
| | Gets the percent (x,y) of the widget in OpenGL coordinates.
|
| |
| void | setPositionType (PositionType type) |
| | Changes the position type of the widget.
|
| |
| PositionType | getPositionType () const |
| | Gets the position type of the widget.
|
| |
| virtual void | setFlippedX (bool flippedX) |
| | Sets whether the widget should be flipped horizontally or not.
|
| |
| virtual bool | isFlippedX () const |
| | Returns the flag which indicates whether the widget is flipped horizontally or not.
|
| |
| virtual void | setFlippedY (bool flippedY) |
| | Sets whether the widget should be flipped vertically or not.
|
| |
| virtual bool | isFlippedY () const |
| | Return the flag which indicates whether the widget is flipped vertically or not.
|
| |
| virtual void | setScaleX (float scaleX) override |
| | Sets the scale (x) of the node.
|
| |
| virtual void | setScaleY (float scaleY) override |
| | Sets the scale (y) of the node.
|
| |
| virtual void | setScale (float scale) override |
| | Sets the scale (x,y,z) of the node.
|
| |
| virtual void | setScale (float scalex, float scaley) override |
| | Sets the scale (x,y) of the node.
|
| |
| virtual float | getScaleX () const override |
| | Returns the scale factor on X axis of this node.
|
| |
| virtual float | getScaleY () const override |
| | Returns the scale factor on Y axis of this node.
|
| |
| virtual float | getScale () const override |
| | Gets the scale factor of the node, when X and Y have the same scale factor.
|
| |
| bool | isClippingParentContainsPoint (const Vec2 &pt) |
| | Checks a point if in parent's area.
|
| |
| const Vec2 & | getTouchBeganPosition () const |
| | Gets the touch began point of widget when widget is selected.
|
| |
| virtual void | setContentSize (const Vec2 &contentSize) override |
| | Changes the size that is widget's size.
|
| |
| virtual void | setSizePercent (const Vec2 &percent) |
| | Changes the percent that is widget's percent size.
|
| |
| void | setSizeType (SizeType type) |
| | Changes the size type of widget.
|
| |
| SizeType | getSizeType () const |
| | Gets the size type of widget.
|
| |
| const Vec2 & | getCustomSize () const |
| | Get the user defined widget size.
|
| |
| virtual const Vec2 & | getLayoutSize () |
| | Get the content size of widget.
|
| |
| const Vec2 & | getSizePercent () |
| | Get size percent of widget.
|
| |
| virtual bool | hitTest (const Vec2 &pt, const Camera *camera, Vec3 *p) const |
| | Checks a point is in widget's content space.
|
| |
| void | setLayoutParameter (LayoutParameter *parameter) |
| | Sets a LayoutParameter to widget.
|
| |
| LayoutParameter * | getLayoutParameter () const override |
| | Gets LayoutParameter of widget.
|
| |
| virtual void | ignoreContentAdaptWithSize (bool ignore) |
| | Toggle whether ignore user defined content size for widget.
|
| |
| bool | isIgnoreContentAdaptWithSize () const |
| | Query whether the widget ignores user defined content size or not.
|
| |
| virtual Node * | getVirtualRenderer () |
| | Gets the inner Renderer node of widget.
|
| |
| virtual Vec2 | getVirtualRendererSize () const |
| | Get the virtual renderer's size.
|
| |
| Widget * | clone () |
| | Create a new widget copy of the original one.
|
| |
| void | updateSizeAndPosition () |
| | Update all children's contents size and position recursively.
|
| |
|
void | updateSizeAndPosition (const Vec2 &parentSize) |
| | Update all children's contents size and position recursively.
|
| |
| void | setActionTag (int tag) |
| | Set the tag of action.
|
| |
| int | getActionTag () const |
| | Get the action tag.
|
| |
| void | setPropagateTouchEvents (bool isPropagate) |
| | Allow widget touch events to propagate to its parents.
|
| |
| bool | isPropagateTouchEvents () const |
| | Return whether the widget is propagate touch events to its parents or not.
|
| |
| void | setSwallowTouches (bool swallow) |
| | Toggle widget swallow touch option.
|
| |
| bool | isSwallowTouches () const |
| | Return whether the widget is swallowing touch or not.
|
| |
| bool | isFocused () const |
| | Query whether widget is focused or not.
|
| |
| void | setFocused (bool focus) |
| | Toggle widget focus status.
|
| |
| bool | isFocusEnabled () const |
| | Query widget's focus enable state.
|
| |
| void | setFocusEnabled (bool enable) |
| | Allow widget to accept focus.
|
| |
|
void | requestFocus () |
| | when a widget calls this method, it will get focus immediately.
|
| |
| void | setUnifySizeEnabled (bool enable) |
| | Toggle use unify size.
|
| |
| bool | isUnifySizeEnabled () const |
| | Query whether unify size enable state.
|
| |
| void | setCallbackName (std::string_view callbackName) |
| | Set callback name.
|
| |
| std::string_view | getCallbackName () const |
| | Query callback name.
|
| |
| void | setCallbackType (std::string_view callbackType) |
| | Set callback type.
|
| |
| std::string_view | getCallbackType () const |
| | Query callback type.
|
| |
| void | setLayoutComponentEnabled (bool enable) |
| | Toggle layout component enable.
|
| |
| bool | isLayoutComponentEnabled () const |
| | Query whether layout component is enabled or not.
|
| |
|
void | propagateTouchEvent (TouchEventType event, Widget *sender, Touch *touch) |
| | Propagate touch events to its parents.
|
| |
| void | onFocusChange (Widget *widgetLostFocus, Widget *widgetGetFocus) |
| | This method is called when a focus change event happens.
|
| |
| void | dispatchFocusEvent (Widget *widgetLoseFocus, Widget *widgetGetFocus) |
| | Dispatch a EventFocus through a EventDispatcher.
|
| |
| virtual void | setScaleZ (float scaleZ) |
| | Changes the scale factor on Z axis of this node.
|
| |
| virtual float | getScaleZ () const |
| | Returns the scale factor on Z axis of this node.
|
| |
|
virtual void | cleanup () override |
| | Stops all running actions and schedulers.
|
| |
| virtual void | onEnterTransitionDidFinish () override |
| | Event callback that is invoked when the Node enters in the 'stage'.
|
| |
| virtual void | onExitTransitionDidStart () override |
| | Event callback that is called every time the Node leaves the 'stage'.
|
| |
| virtual void | updateDisplayedOpacity (uint8_t parentOpacity) override |
| | Update the displayed opacity of node with it's parent opacity;.
|
| |
| virtual void | updateDisplayedColor (const Color3B &parentColor) override |
| | Update node's displayed color with its parent color.
|
| |
| virtual void | addProtectedChild (Node *child) |
| | Adds a child to the container with z-order as 0.
|
| |
| virtual void | addProtectedChild (Node *child, int localZOrder) |
| | Adds a child to the container with a local z-order.
|
| |
| virtual void | addProtectedChild (Node *child, int localZOrder, int tag) |
| | Adds a child to the container with z order and tag.
|
| |
| virtual Node * | getProtectedChildByTag (int tag) |
| | Gets a child from the container with its tag.
|
| |
| virtual Node * | getProtectedChildByName (std::string_view name) |
| | Gets a child from the container with its name.
|
| |
| virtual void | removeProtectedChild (Node *child, bool cleanup=true) |
| | Removes a child from the container.
|
| |
| virtual void | removeProtectedChildByTag (int tag, bool cleanup=true) |
| | Removes a child from the container by tag value.
|
| |
| virtual void | removeAllProtectedChildren () |
| | Removes all children from the container with a cleanup.
|
| |
| virtual void | removeAllProtectedChildrenWithCleanup (bool cleanup) |
| | Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.
|
| |
| virtual void | reorderProtectedChild (Node *child, int localZOrder) |
| | Reorders a child according to a new z value.
|
| |
| virtual void | sortAllProtectedChildren () |
| | Sorts the children array once before drawing, instead of every time when a child is added or reordered.
|
| |
| virtual bool | isRunning () const |
| | Returns whether or not the node is "running".
|
| |
| void | scheduleUpdateWithPriorityLua (int handler, int priority) |
| | Schedules for lua script.
|
| |
| virtual void | draw (Renderer *renderer, const Mat4 &transform, uint32_t flags) |
| | Override this method to draw your own node.
|
| |
| virtual Scene * | getScene () const |
| | Returns the Scene that contains the Node.
|
| |
| virtual Rect | getBoundingBox () const |
| | Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.
|
| |
| virtual void | setEventDispatcher (EventDispatcher *dispatcher) |
| | Set event dispatcher for scene.
|
| |
| virtual EventDispatcher * | getEventDispatcher () const |
| | Get the event dispatcher of scene.
|
| |
| virtual uint8_t | getOpacity () const |
| | Return the node's opacity.
|
| |
| virtual uint8_t | getDisplayedOpacity () const |
| | Return the node's display opacity.
|
| |
| virtual void | setOpacity (uint8_t opacity) |
| | Change node opacity.
|
| |
| virtual bool | isCascadeOpacityEnabled () const |
| | Whether cascadeOpacity is enabled or not.
|
| |
| virtual void | setCascadeOpacityEnabled (bool cascadeOpacityEnabled) |
| | Change node's cascadeOpacity property.
|
| |
| virtual const Color3B & | getColor () const |
| | Query node's color value.
|
| |
| virtual const Color3B & | getDisplayedColor () const |
| | Query node's displayed color.
|
| |
| virtual void | setColor (const Color3B &color) |
| | Change the color of node.
|
| |
| virtual bool | isCascadeColorEnabled () const |
| | Query whether cascadeColor is enabled or not.
|
| |
| virtual void | setCascadeColorEnabled (bool cascadeColorEnabled) |
| | If you want node's color affect the children node's color, then set it to true.
|
| |
| virtual void | setOpacityModifyRGB (bool value) |
| | If you want the opacity affect the color property, then set to true.
|
| |
| virtual bool | isOpacityModifyRGB () const |
| | If node opacity will modify the RGB color value, then you should override this method and return true.
|
| |
| void | setOnEnterCallback (const std::function< void()> &callback) |
| | Set the callback of event onEnter.
|
| |
| const std::function< void()> & | getOnEnterCallback () const |
| | Get the callback of event onEnter.
|
| |
| void | setOnExitCallback (const std::function< void()> &callback) |
| | Set the callback of event onExit.
|
| |
| const std::function< void()> & | getOnExitCallback () const |
| | Get the callback of event onExit.
|
| |
| void | setOnEnterTransitionDidFinishCallback (const std::function< void()> &callback) |
| | Set the callback of event EnterTransitionDidFinish.
|
| |
| const std::function< void()> & | getOnEnterTransitionDidFinishCallback () const |
| | Get the callback of event EnterTransitionDidFinish.
|
| |
| void | setOnExitTransitionDidStartCallback (const std::function< void()> &callback) |
| | Set the callback of event ExitTransitionDidStart.
|
| |
| const std::function< void()> & | getOnExitTransitionDidStartCallback () const |
| | Get the callback of event ExitTransitionDidStart.
|
| |
|
unsigned short | getCameraMask () const |
| | get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
|
| |
| void | applyMaskOnEnter (bool applyChildren) |
| | Should addChild() make the child follow it's parent's mask?
|
| |
| virtual bool | setProgramState (backend::ProgramState *programState, bool ownPS=false) |
| | Sets ProgramState with retain.
|
| |
| backend::ProgramState * | setProgramStateByProgramId (uint64_t progId) |
| | Sets ProgramState by programId.
|
| |
| virtual void | setLocalZOrder (int localZOrder) |
| | LocalZOrder is the 'key' used to sort the node relative to its siblings.
|
| |
| void | updateOrderOfArrival () |
| | !
|
| |
| virtual int | getLocalZOrder () const |
| | Gets the local Z order of this node.
|
| |
| virtual float | getGlobalZOrder () const |
| | Returns the Node's Global Z Order.
|
| |
| virtual const Vec2 & | getPosition () const |
| | Gets the position (x,y) of the node in its parent's coordinate system.
|
| |
| virtual const Vec2 & | getPositionNormalized () const |
| | Returns the normalized position.
|
| |
| virtual void | setPosition (float x, float y) |
| | Sets the position (x,y) of the node in its parent's coordinate system.
|
| |
| virtual void | getPosition (float *x, float *y) const |
| | Gets position in a more efficient way, returns two number instead of a Vec2 object.
|
| |
| virtual void | setPositionX (float x) |
| | Gets/Sets x or y coordinate individually for position.
|
| |
| virtual float | getPositionX () const |
| | Gets the x coordinate of the node in its parent's coordinate system.
|
| |
| virtual void | setPositionY (float y) |
| | Sets the y coordinate of the node in its parent's coordinate system.
|
| |
| virtual float | getPositionY () const |
| | Gets the y coordinate of the node in its parent's coordinate system.
|
| |
| virtual void | setPosition3D (const Vec3 &position) |
| | Sets the position (X, Y, and Z) in its parent's coordinate system.
|
| |
| virtual Vec3 | getPosition3D () const |
| | Returns the position (X,Y,Z) in its parent's coordinate system.
|
| |
| virtual void | setPositionZ (float positionZ) |
| | Sets the 'z' coordinate in the position.
|
| |
| virtual float | getPositionZ () const |
| | Gets position Z coordinate of this node.
|
| |
| virtual void | setSkewX (float skewX) |
| | Changes the X skew angle of the node in degrees.
|
| |
| virtual float | getSkewX () const |
| | Returns the X skew angle of the node in degrees.
|
| |
| virtual void | setSkewY (float skewY) |
| | Changes the Y skew angle of the node in degrees.
|
| |
| virtual float | getSkewY () const |
| | Returns the Y skew angle of the node in degrees.
|
| |
| virtual void | setAnchorPoint (const Vec2 &anchorPoint) |
| | Sets the anchor point in percent.
|
| |
| virtual const Vec2 & | getAnchorPoint () const |
| | Returns the anchor point in percent.
|
| |
| virtual const Vec2 & | getAnchorPointInPoints () const |
| | Returns the anchorPoint in absolute pixels.
|
| |
| virtual const Vec2 & | getContentSize () const |
| | Returns the untransformed size of the node.
|
| |
| virtual bool | hitTest (const Vec2 &worldPoint) const |
| | The basic node hit test, since axmol-1.0.
|
| |
| virtual void | setVisible (bool visible) |
| | Sets whether the node is visible.
|
| |
| virtual bool | isVisible () const |
| | Determines if the node is visible.
|
| |
| virtual void | setRotation (float rotation) |
| | Sets the rotation (angle) of the node in degrees.
|
| |
| virtual float | getRotation () const |
| | Returns the rotation of the node in degrees.
|
| |
| virtual void | setRotation3D (const Vec3 &rotation) |
| | Sets the rotation (X,Y,Z) in degrees.
|
| |
| virtual Vec3 | getRotation3D () const |
| | Returns the rotation (X,Y,Z) in degrees.
|
| |
| virtual void | setRotationQuat (const Quaternion &quat) |
| | Set rotation by quaternion.
|
| |
| virtual Quaternion | getRotationQuat () const |
| | Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise.
|
| |
| virtual void | setRotationSkewX (float rotationX) |
| | Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew.
|
| |
| virtual float | getRotationSkewX () const |
| | Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.
|
| |
| virtual void | setRotationSkewY (float rotationY) |
| | Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.
|
| |
| virtual float | getRotationSkewY () const |
| | Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.
|
| |
| virtual void | setIgnoreAnchorPointForPosition (bool ignore) |
| | Sets whether the anchor point will be (0,0) when you position this node.
|
| |
| virtual bool | isIgnoreAnchorPointForPosition () const |
| | Gets whether the anchor point will be (0,0) when you position this node.
|
| |
| virtual int | getTag () const |
| | Returns a tag that is used to identify the node easily.
|
| |
| virtual void | setTag (int tag) |
| | Changes the tag that is used to identify the node easily.
|
| |
| virtual std::string_view | getName () const |
| | Returns a string that is used to identify the node.
|
| |
| virtual void | setName (std::string_view name) |
| | Changes the name that is used to identify the node easily.
|
| |
| virtual void * | getUserData () |
| | Returns a custom user data pointer.
|
| |
|
virtual const void * | getUserData () const |
| | @lua NA
|
| |
| virtual void | setUserData (void *userData) |
| | Sets a custom user data pointer.
|
| |
| virtual Object * | getUserObject () |
| | Returns a user assigned Object.
|
| |
|
virtual const Object * | getUserObject () const |
| | @lua NA
|
| |
| virtual void | setUserObject (Object *userObject) |
| | Returns a user assigned Object.
|
| |
| virtual void | setActionManager (ActionManager *actionManager) |
| | Sets the ActionManager object that is used by all actions.
|
| |
| virtual ActionManager * | getActionManager () |
| | Gets the ActionManager object that is used by all actions.
|
| |
| virtual Action * | runAction (Action *action) |
| | Executes an action, and returns the action that is executed.
|
| |
|
void | stopAllActions () |
| | Stops and removes all actions from the running action list .
|
| |
| void | stopAction (Action *action) |
| | Stops and removes an action from the running action list.
|
| |
| void | stopActionByTag (int tag) |
| | Removes an action from the running action list by its tag.
|
| |
| void | stopAllActionsByTag (int tag) |
| | Removes all actions from the running action list by its tag.
|
| |
| void | stopActionsByFlags (unsigned int flags) |
| | Removes all actions from the running action list by its flags.
|
| |
| Action * | getActionByTag (int tag) |
| | Gets an action from the running action list by its tag.
|
| |
| ssize_t | getNumberOfRunningActions () const |
| | Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays).
|
| |
| ssize_t | getNumberOfRunningActionsByTag (int tag) const |
| | Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays) with a specific tag.
|
| |
| virtual void | setScheduler (Scheduler *scheduler) |
| | Sets a Scheduler object that is used to schedule all "updates" and timers.
|
| |
| virtual Scheduler * | getScheduler () |
| | Gets a Scheduler object.
|
| |
| bool | isScheduled (SEL_SCHEDULE selector) const |
| | Checks whether a selector is scheduled.
|
| |
| bool | isScheduled (std::string_view key) const |
| | Checks whether a lambda function is scheduled.
|
| |
| void | scheduleUpdate () |
| | Schedules the "update" method.
|
| |
| void | scheduleUpdateWithPriority (int priority) |
| | Schedules the "update" method with a custom priority.
|
| |
| void | schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay) |
| | Schedules a custom selector.
|
| |
| void | schedule (SEL_SCHEDULE selector, float interval) |
| | Schedules a custom selector with an interval time in seconds.
|
| |
| void | scheduleOnce (SEL_SCHEDULE selector, float delay) |
| | Schedules a selector that runs only once, with a delay of 0 or larger.
|
| |
| void | scheduleOnce (const std::function< void(float)> &callback, float delay, std::string_view key) |
| | Schedules a lambda function that runs only once, with a delay of 0 or larger.
|
| |
| void | schedule (SEL_SCHEDULE selector) |
| | Schedules a custom selector, the scheduled selector will be ticked every frame.
|
| |
| void | schedule (const std::function< void(float)> &callback, std::string_view key) |
| | Schedules a lambda function.
|
| |
| void | schedule (const std::function< void(float)> &callback, float interval, std::string_view key) |
| | Schedules a lambda function.
|
| |
| void | schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, std::string_view key) |
| | Schedules a lambda function.
|
| |
| void | unschedule (SEL_SCHEDULE selector) |
| | Unschedules a custom selector.
|
| |
| void | unschedule (std::string_view key) |
| | Unschedules a lambda function.
|
| |
| void | unscheduleAllCallbacks () |
| | Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions.
|
| |
| virtual void | resume () |
| | Resumes all scheduled selectors, actions and event listeners.
|
| |
| virtual void | pause () |
| | Pauses all scheduled selectors, actions and event listeners.
|
| |
| virtual void | updateTransform () |
| | Calls children's updateTransform() method recursively.
|
| |
| virtual const Mat4 & | getNodeToParentTransform () const |
| | Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.
|
| |
| virtual Mat4 | getNodeToParentTransform (Node *ancestor) const |
| | Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates.
|
| |
| virtual AffineTransform | getNodeToParentAffineTransform (Node *ancestor) const |
| | Returns the affine transform matrix that transform the node's (local) space coordinates into the parent's space coordinates.
|
| |
| virtual void | setNodeToParentTransform (const Mat4 &transform) |
| | Sets the transformation matrix manually.
|
| |
| virtual const Mat4 & | getParentToNodeTransform () const |
| | Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.
|
| |
| virtual Mat4 | getNodeToWorldTransform () const |
| | Returns the world affine transform matrix.
|
| |
| virtual Mat4 | getWorldToNodeTransform () const |
| | Returns the inverse world affine transform matrix.
|
| |
| Vec2 | convertToNodeSpace (const Vec2 &worldPoint) const |
| | Converts a Vec2 to node (local) space coordinates.
|
| |
| Vec2 | convertToWorldSpace (const Vec2 &nodePoint) const |
| | Converts a Vec2 to world space coordinates.
|
| |
| Vec2 | convertToNodeSpaceAR (const Vec2 &worldPoint) const |
| | Converts a Vec2 to node (local) space coordinates.
|
| |
| Vec2 | convertToWorldSpaceAR (const Vec2 &nodePoint) const |
| | Converts a local Vec2 to world space coordinates.The result is in Points.
|
| |
| Vec2 | convertTouchToNodeSpace (Touch *touch) const |
| | convenience methods which take a Touch instead of Vec2.
|
| |
| Vec2 | convertTouchToNodeSpaceAR (Touch *touch) const |
| | converts a Touch (world coordinates) into a local coordinate.
|
| |
| Vec2 | getWorldPosition () const |
| | Gets position of node in world space.
|
| |
| void | setWorldPosition (const Vec2 &position) |
| | Sets position of node in world space.
|
| |
| void | setAdditionalTransform (const Mat4 *additionalTransform) |
| | Sets an additional transform matrix to the node.
|
| |
| Component * | getComponent (std::string_view name) |
| | Gets a component by its name.
|
| |
| virtual bool | addComponent (Component *component) |
| | Adds a component.
|
| |
| virtual bool | removeComponent (std::string_view name) |
| | Removes a component by its name.
|
| |
| virtual bool | removeComponent (Component *component) |
| | Removes a component by its pointer.
|
| |
|
virtual void | removeAllComponents () |
| | Removes all components.
|
| |
| template<typename T> |
| T | getChildByTag (int tag) const |
| | Gets a child from the container with its tag that can be cast to Type T.
|
| |
| template<typename T> |
| T | getChildByName (std::string_view name) const |
| | Gets a child from the container with its name that can be cast to Type T.
|
| |
| virtual void | enumerateChildren (std::string_view name, std::function< bool(Node *node)> callback) const |
| | Search the children of the receiving node to perform processing for nodes which share a name.
|
| |
| virtual void | setParent (Node *parent) |
| | Sets the parent node.
|
| |
| virtual Node * | getParent () |
| | Returns a pointer to the parent node.
|
| |
| virtual void | removeFromParent () |
| | Removes this node itself from its parent node with a cleanup.
|
| |
| virtual void | removeFromParentAndCleanup (bool cleanup) |
| | Removes this node itself from its parent node.
|
| |
| virtual void | removeChildByTag (int tag, bool cleanup=true) |
| | Removes a child from the container by tag value.
|
| |
| virtual void | removeChildByName (std::string_view name, bool cleanup=true) |
| | Removes a child from the container by tag value.
|
| |
| virtual void | reorderChild (Node *child, int localZOrder) |
| | Reorders a child according to a new z value.
|
| |
| virtual void | sortAllChildren () |
| | Sorts the children array once before drawing, instead of every time when a child is added or reordered.
|
| |
| void | retain () |
| | Retains the ownership.
|
| |
| void | release () |
| | Releases the ownership immediately.
|
| |
| Object * | autorelease () |
| | Releases the ownership sometime soon automatically.
|
| |
| unsigned int | getReferenceCount () const |
| | Returns the Object's current reference count.
|
| |
| virtual | ~Object () |
| | Destructor.
|
| |
|
virtual | ~LayoutParameterProtocol () |
| | Default destructor.
|
| |
Public Types inherited from ScrollView
1.13.2