The EffectLine class is using the TexturedLine class to draw animated lines. These can be used to draw things such as smoke trails, electricity effects, or other animated types of lines.

Inheritance

Constructors

EffectLine({Texture texture: null, TransferMode transferMode: TransferMode.dstOver, List<Point> points, EffectLineWidthMode widthMode: EffectLineWidthMode.linear, double minWidth: 10.0, double maxWidth: 10.0, double widthGrowthSpeed: 0.0, EffectLineAnimationMode animationMode: EffectLineAnimationMode.none, double scrollSpeed: 0.1, double scrollStart: 0.0, double fadeDuration: null, double fadeAfterDelay: null, double textureLoopLength: null, bool simplify: true, ColorSequence colorSequence })

Creates a new EffectLine with the specified parameters. Only the texture parameter is required, all other parameters are optional.

Properties

actions ActionController

The ActionController associated with this node.

read-only, inherited
animationMode EffectLineAnimationMode

The mode used to animate the texture of the line.

read-only
children List<Node>

A list of the children of this node.

read-only, inherited
colorSequence ColorSequence

Color gradient used to draw the line, from start to finish.

read-only
constraints List<Constraint>

A List of Constraints that will be applied to the node. The constraints are applied after the update method has been called.

read / write, inherited
fadeAfterDelay double

The time it takes until an added point starts to fade out.

read-only
fadeDuration double

The time it takes for an added point to fade out. It's total life time is fadeDuration + fadeAfterDelay.

read-only
handleMultiplePointers bool

If set to true the node will receive multiple pointers, otherwise it will only receive events the first pointer.

read / write, inherited
hashCode int

Get a hash code for this object.

read-only, inherited
inverseTransformMatrix → Matrix4

The inverse transform matrix used by this node.

read-only, inherited
maxWidth double

The width of the line at its thickest point.

read-only
minWidth double

The width of the line at its thinnest point.

read-only
parent Node

The parent of this node, or null if it doesn't have a parent.

read-only, inherited
paused bool

Decides if the node and its children is currently paused.

read / write, inherited
points List<Point>

List of points that make up the line. Typically, you will only want to set this at the beginning. Then use addPoint to add additional points to the line.

read / write
position Point

The position of this node relative to its parent.

read / write, inherited
rotation double

The rotation of this node in degrees.

read / write, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited
scale double

The scale of this node relative its parent.

read / write, inherited
scaleX double

The horizontal scale of this node relative its parent.

read / write, inherited
scaleY double

The vertical scale of this node relative its parent.

read / write, inherited
scrollSpeed double

The speed of which the texture of the line is scrolling. This property is only used if the animationMode is set to EffectLineAnimationMode.scroll.

read-only
simplify bool

True if the line should be simplified by removing points that are close to other points. This makes drawing faster, but can result in a slight jittering effect when points are added.

read-only
skewX double

The skew along the x-axis of this node in degrees.

read / write, inherited
skewY double

The skew along the y-axis of this node in degrees.

read / write, inherited
spriteBox SpriteBox

The SpriteBox this node is added to, or null if it's not currently added to a SpriteBox.

read-only, inherited
texture Texture

The texture used to draw the line.

read-only
textureLoopLength double

The length, in points, that the texture is stretched to. If the textureLoopLength is shorter than the line, the texture will be looped.

read-only
transferMode TransferMode

The transfer mode used to draw the line, default is TransferMode.dstOver.

read-only
transformMatrix → Matrix4

The transformMatrix describes the transformation from the node's parent.

read-only, inherited
userInteractionEnabled bool

The node will receive user interactions, such as pointer (touch or mouse) events.

read / write, inherited
visible bool

The visibility of this node and its children.

read / write, inherited
widthGrowthSpeed double

The speed at which the line is growing, defined in points per second.

read-only
widthMode EffectLineWidthMode

Mode used to calculate the width of the line.

read-only
zPosition double

The draw order of this node compared to its parent and its siblings.

read / write, inherited

Operators

operator ==(other) bool

The equality operator.

inherited

Methods

addChild(Node child) → void

Adds a child to this node.

inherited
addPoint(Point point) → void

Adds a new point to the end of the line.

applyConstraints(double dt) → void

Called to apply the constraints to the node. Normally, this method is called automatically by the SpriteBox, but it can be called manually if the constraints need to be applied immediately.

inherited
computeTransformMatrix() → Matrix4

Computes the transformation matrix of this node. This method can be overriden if a custom matrix is required. There is usually no reason to call this method directly.

inherited
convertPointFromNode(Point point, Node node) Point

Converts a point from another nodes coordinate system into the local coordinate system of this node.

inherited
convertPointToBoxSpace(Point nodePoint) Point

Converts a point from the local coordinate system of the node to the coordinate system of the SpriteBox.

inherited
convertPointToNodeSpace(Point boxPoint) Point

Converts a point from the coordinate system of the SpriteBox to the local coordinate system of the node.

inherited
handleEvent(SpriteBoxEvent event) bool

Handles an event, such as a pointer (touch or mouse) event.

inherited
invalidateTransformMatrix() → void

Invalidates the current transform matrix. If the computeTransformMatrix method is overidden, this method should be called whenever a property changes that affects the matrix.

inherited
isPointInside(Point point) bool

Returns true if the point is inside the node, the point is in the local coordinate system of the node.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
paint(Canvas canvas) → void

Paints this node to the canvas.

removeAllChildren() → void

Removes all children of this node.

inherited
removeChild(Node child) → void

Removes a child from this node.

inherited
removeFromParent() → void

Removes this node from its parent node.

inherited
spriteBoxPerformedLayout() → void

Called whenever the SpriteBox is modified or resized, or if the device is rotated.

inherited
toString() String

Returns a string representation of this object.

inherited
update(double dt) → void

Called before a frame is drawn.