# node

# ZKNode

TIP

ZKNode is the base class for all Zerker display objects, and it contains most of the basic information.

CODE:

var node = ZKNode()
    ..rotation = 90
    ..position.x = x
    ..position.y = y;

this.stage.addChild(node);

# Constructor

# ZKNode()

# Properties

Name	Type	Defaults	Description
`id`	String	(uuid)	ZKNode Unique id
`type`	String	"ZKNode"	Type of this node
`anchor`	Point	Point(0.5, 0.5)	The offset scale for this node's registration point
`position`	Point	Point(0, 0)	The position of the node, relative to its parent.
`skew`	Point	Point(0, 0)	The factor to skew this node
`rotation`	double	0	The rotation in degrees for this node. [0-360]
`width`	double	0	The display width of this node
`height`	double	0	The display height of this node
`oriWidth`	double	0	The original width(or content width) of this node object
`oriHeight`	double	0	The original height(or content height) of this node object
`alpha`	double	1	The alpha of this node. [0-1]
`visible`	bool	true	Whether to display nodes
`interactive`	bool	true	Whether the node allows interactive events, Note: This property is used in conjunction with `stage.interactive`.
`parent`	ZKContainer	null	A reference to the `ZKContainer` or `ZKStage` object that contains this display object, or null if it has not been added to one.
`color`	Color	Colors.blue	Set brush color.
`paint`	Paint	Paint()	The default Paint of this canvas, you can configure Paint to achieve various effects.
`center`	Offset	Offset(0,0)	The offset for this node's registration point
`debug`	bool	false	Use debug to easily debug your application.
`onTapDown`	Function	null	Gesture touch interaction function, start clicking.
`onTapMove`	Function	null	Gesture touch interaction function, Touch movement.
`onTapUp`	Function	null	Gesture touch interaction function, End of touch.
`context`	ZKContext	null	Operational context, including some common methods and variables.

# Methods

# void draw(Canvas canvas, [Size size])
- Component drawing function for drawing display content.
# void setPosition(double x, double y)
- Set the position.x and the position.x property.
# void setScale(double s)
- Set both the scaleX and the scaleY property to the same value.
# void remove()
- Remove from parent component.
# Map<String, double> toMap
- Translate a map of a component for ZKTween.
# String toString()
- Returns a string representation of this node.
# void dispose()
- Destroy components and free up memory.

# ZKContainer

TIP

ZKContainer is a container component that can contain other components

CODE:

var con = ZKContainer()
    ..position.x = x
    ..position.y = y;
    ..addChild(node1)
    ..addChildAt(sprite, 2)

this.stage.addChild(con);

# Constructor

# ZKContainer()
- ZKContainer inherits from ZKNode.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKContainer"	Type of this node
`children`	List	[]	The array of children in the display list.

# Other properties are inherited from ZKNode, please check.

# Methods

# ZKNode getChild(int index)
- Get a child based on index.
# void addChild(ZKNode child)
- Adds a child to the top of the display list..
# void removeChild(ZKNode child)
- Removes the specified child from the display list.
# void removeAllChild()
- Delete all children.
# void addChildAt(ZKNode child, int index)
- Adds a child to the display list at the specified index.
# void forEach(Function(ZKNode child) func)
- Loop Execution Child.

# Other methods are inherited from ZKNode, please check.

# ZKScene

TIP

Scene component can be used to switch.

CODE:

var scene1 = ZKScene()
    ..addChild(hum)
    ..addChild(tree)
    ..addChild(stone)
    ..fadeIn();

# Constructor

# ZKScene()
- ZKScene inherits from ZKContainer.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKScene"	Type of this node

# Other properties are inherited from ZKContainer, please check.

# Methods

# void fadeIn([int time = 1600, Function onComplete])
- Scene component admission animation, including fade in, cut in, etc.
# void fadeOut([int time = 1000, Function onComplete])
- Scene component animation, including fade out, cut out, etc.
# void moveIn({double x, double y, int time = 1600, Function onComplete, dynamic ease})
- Scene component admission animation, including move in, cut in, etc.
# void moveOut({double x, double y, int time = 1000, Function onComplete, dynamic ease})
- Scene component animation, including move out, cut out, etc.

# Other methods are inherited from ZKContainer, please check.

# ZKStage

TIP

This component is the only stage of a ZKApp.

CODE:

this.stage.addChild(node);

# Constructor

# ZKStage()
- ZKStage inherits from ZKContainer.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKStage"	Type of this node

# Other properties are inherited from ZKContainer, please check.

# Methods

# Other methods are inherited from ZKContainer, please check.

# ZKGraphic

TIP

The Graphic class exposes an easy to use API for generating vector drawing instructions and drawing them to a specified context.

CODE:

var node = ZKGraphic()
    ..position.x = x
    ..position.y = y
    ..drawRect(0.0, 0.0, 100.0, 100.0)
    ..setStyle(color: Colors.cyan)
    ..drawRect(-10.0, -110.0, 20.0, 100.0)
    ..setStyle(color: Colors.red)
    ..drawCircle(-120.0, -10.0, 50.0)
    ..setStyle(color: Colors.green)
    ..drawTriangle(120.0, -10.0, 50.0, 50.0, 150.0, 250.0);

# Constructor

# ZKGraphic()
- ZKGraphic inherits from ZKNode.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKGraphic"	Type of this node

# Other properties are inherited from ZKNode, please check.

# Methods

# void drawArc(double x, double y, double r, double sAngle, double eAngle, [bool useCenter = true])
- Draw ace api
# void drawOval(double x, double y, double w, double h)
- Draw Oval api
# void drawRect(double x, double y, double w, double h)
- Draw Rect api
# void drawCircle(double x, double y, double radius)
- Draw Circle api
# void drawTriangle(double x1, double y1, double x2, double y2, double x3, double y3)
- Draw Triangle api.
# void drawLine(double x1, double y1, double x2, double y2)
- Draw line api.
# void clear()
- Empty component.
# void setStyle
- Set the style of the derivative method.

setStyle(
      {BlendMode blendMode,
      Color color,
      ColorFilter colorFilter,
      FilterQuality filterQuality,
      bool invertColors,
      bool isAntiAlias,
      StrokeCap strokeCap,
      StrokeJoin strokeJoin,
      double strokeMiterLimit,
      double strokeWidth,
      PaintingStyle style})

# Other methods are inherited from ZKNode, please check.

# ZKText

TIP

Display one or more lines of dynamic text (not user editable) in the display list.

CODE:

var text = ZKText()
    ..position.x = x
    ..position.y = y
    ..text = "Hello world"
    ..setStyle(color: Colors.blueGrey, backgroundColor: Colors.red[50]);

# Constructor

# ZKText()
- ZKText inherits from ZKNode.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKText"	Type of this node
`text`	String	""	The text to display
`style`	TextStyle	(inherit: false, color: Colors.blue, fontSize: 16.0)	The text style of the component

# Other properties are inherited from ZKNode, please check.

# Methods

# void setText(String t)
- setText.
# void setStyle
- Set the style of the derivative method.

setStyle(
      {bool inherit: false,
      Color color: Colors.blue,
      Color backgroundColor,
      double fontSize: 16.0,
      FontWeight fontWeight,
      FontStyle fontStyle,
      double letterSpacing,
      double wordSpacing,
      double height,
      Paint background,
      List<Shadow> shadows,
      TextDecoration decoration,
      Color decorationColor,
      TextDecorationStyle decorationStyle,
      double decorationThickness,
      String fontFamily,

      /// text pos style
      TextAlign textAlign: TextAlign.center,
      TextDirection textDirection: TextDirection.ltr,
      double textScaleFactor: 1.0,
      int maxLines,
      String ellipsis,
      StrutStyle strutStyle,
      TextWidthBasis textWidthBasis: TextWidthBasis.parent})

# Other methods are inherited from ZKNode, please check.

# ZKImage

TIP

Image component.

CODE:

var img = ZKImage(url)
    ..position.x = x
    ..position.y = y
    ..onLoad = (){
      print("img loaded")
    }
    ..onError = (err){
      print("img load err because $err")
    };

# Constructor

# ZKImage([String url])
- ZKImage inherits from ZKNode.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKImage"	Type of this node
`image`	Image	null	Original image, ui.Image
`clip`	Rect	null	Cut display area of the Image
`onLoad`	Function	null	Image loaded successfully
`onError`	Function	null	Image failed to load
`frame`	Frame	null	Render frame

# Other properties are inherited from ZKNode, please check.

# Methods

# void load(String url) async
- Image loading function.

# Other methods are inherited from ZKNode, please check.

# ZKSprite

TIP

The sprite component is a very useful component, you can do a lot of effects with it.

CODE:

var hum = Sprite(key: "hum")
    ..position.x = x
    ..position.y = y

# Constructor

# ZKSprite({String image, String key, String type, String json, double width = 100, double height = 100})
- ZKSprite inherits from ZKNode.

# Properties

Name	Type	Defaults	Description
`type`	String	"ZKSprite"	Type of this node
`texture`	BaseTexture	null	Sprite component texture material
`textureType`	String	null	Sprite component texture material type
`onLoad`	Function	null	ZKSprite loaded successfully
`onError`	Function	null	ZKSprite failed to load
`frame`	Frame	null	Render frame
`animator`	Animator	null	Frame Animation Manager

# Other properties are inherited from ZKNode, please check.

# Methods

# void load(String url) async
- Image loading function.
# void play(String name, [int rate, bool loop = false])
- Play Method of Animator (Combination)
# void stop([String name])
- Stop Method of Animator (Combination)

# Other methods are inherited from ZKNode, please check.

extras →

# node

# ZKNode

# Constructor

# ZKNode()

# Properties

# Methods

# void draw(Canvas canvas, [Size size])

# void setPosition(double x, double y)

# void setScale(double s)

# void remove()

# Map<String, double> toMap

# String toString()

# void dispose()

# ZKContainer

# Constructor

# ZKContainer()

# Properties

# Other properties are inherited from ZKNode, please check.

# Methods

# ZKNode getChild(int index)

# void addChild(ZKNode child)

# void removeChild(ZKNode child)

# void removeAllChild()

# void addChildAt(ZKNode child, int index)

# void forEach(Function(ZKNode child) func)

# Other methods are inherited from ZKNode, please check.

# ZKScene

# Constructor

# ZKScene()

# Properties

# Other properties are inherited from ZKContainer, please check.

# Methods

# void fadeIn([int time = 1600, Function onComplete])

# void fadeOut([int time = 1000, Function onComplete])

# void moveIn({double x, double y, int time = 1600, Function onComplete, dynamic ease})

# void moveOut({double x, double y, int time = 1000, Function onComplete, dynamic ease})

# Other methods are inherited from ZKContainer, please check.

# ZKStage

# Constructor

# ZKStage()

# Properties

# Other properties are inherited from ZKContainer, please check.

# Methods

# Other methods are inherited from ZKContainer, please check.

# ZKGraphic

# Constructor

# ZKGraphic()

# Properties

# Other properties are inherited from ZKNode, please check.

# Methods

# void drawArc(double x, double y, double r, double sAngle, double eAngle, [bool useCenter = true])

# void drawOval(double x, double y, double w, double h)

# void drawRect(double x, double y, double w, double h)

# void drawCircle(double x, double y, double radius)

# void drawTriangle(double x1, double y1, double x2, double y2, double x3, double y3)

# void drawLine(double x1, double y1, double x2, double y2)

# void clear()

# void setStyle

# Other methods are inherited from ZKNode, please check.

# ZKText

# Constructor

# ZKText()

# Properties

# Other properties are inherited from ZKNode, please check.

# Methods

# void setText(String t)

# void setStyle

# Other methods are inherited from ZKNode, please check.

# ZKImage

# Constructor

# ZKImage([String url])

# Properties

# Other properties are inherited from ZKNode, please check.

# Methods

# void load(String url) async

# Other methods are inherited from ZKNode, please check.

# ZKSprite

# Constructor

# ZKSprite({String image, String key, String type, String json, double width = 100, double height = 100})

# Properties

# `ZKNode()`

# `void draw(Canvas canvas, [Size size])`

# `void setPosition(double x, double y)`

# `void setScale(double s)`

# `void remove()`

# `Map<String, double> toMap`

# `String toString()`

# `void dispose()`

# `ZKContainer()`

# `ZKNode getChild(int index)`

# `void addChild(ZKNode child)`

# `void removeChild(ZKNode child)`

# `void removeAllChild()`

# `void addChildAt(ZKNode child, int index)`

# `void forEach(Function(ZKNode child) func)`

# `ZKScene()`

# `void fadeIn([int time = 1600, Function onComplete])`

# `void fadeOut([int time = 1000, Function onComplete])`

# `void moveIn({double x, double y, int time = 1600, Function onComplete, dynamic ease})`

# `void moveOut({double x, double y, int time = 1000, Function onComplete, dynamic ease})`

# `ZKStage()`

# `ZKGraphic()`

# `void drawArc(double x, double y, double r, double sAngle, double eAngle, [bool useCenter = true])`

# `void drawOval(double x, double y, double w, double h)`

# `void drawRect(double x, double y, double w, double h)`

# `void drawCircle(double x, double y, double radius)`

# `void drawTriangle(double x1, double y1, double x2, double y2, double x3, double y3)`

# `void drawLine(double x1, double y1, double x2, double y2)`

# `void clear()`

# `void setStyle`

# `ZKText()`

# `void setText(String t)`

# `void setStyle`

# `ZKImage([String url])`

# `void load(String url) async`

# `ZKSprite({String image, String key, String type, String json, double width = 100, double height = 100})`

# `void load(String url) async`

# `void play(String name, [int rate, bool loop = false])`

# `void stop([String name])`