Graphics.Line2d
Description: Defines a drawable 2d line element.
Constructors
Line2d (fromX, fromY, toX, toY)
Creates a new instance of the Line2d object with a line width of 1.
fromX: number
Starting horizontal coordinate.
fromY: number
Starting vertical coordinate.
toX: number
Ending horizontal coordinate.
toY: number
Ending vertical coordinate.
Line2d (fromX, fromY, toX, toY, lineWidth)
Creates a new instance of the Line2d object with a specified line width.
fromX: number
Starting horizontal coordinate.
fromY: number
Starting vertical coordinate.
toX: number
Ending horizontal coordinate.
toY: number
Ending vertical coordinate.
lineWidth: number
Initial thickness of the line.
Line2d (fromX, fromY, toX, toY, lineWidth, color)
Creates a new instance of the Line2d object with a specified line width and color.
fromX: number
Starting horizontal coordinate.
fromY: number
Starting vertical coordinate.
toX: number
Ending horizontal coordinate.
toY: number
Ending vertical coordinate.
lineWidth: number
Initial thickness of the line.
Line2d (fromX, fromY, toX, toY, lineWidth, color)
Creates a new instance of the Line2d object with a specified line width and color.
fromX: number
Starting horizontal coordinate.
fromY: number
Starting vertical coordinate.
toX: number
Ending horizontal coordinate.
toY: number
Ending vertical coordinate.
lineWidth: number
Initial thickness of the line.
color: string
Initial color string of the line.
Fields
Color: Graphics.Color
Gets or sets the line color. Valid colors are strings like "red" or "rgb(255,0,0)".
LineWidth: number
Gets or sets the line width.
LineCap: string
Gets or sets the line cap. Values can be "butt", "round", "square".
Inherited from: Graphics.Graphic2d
ZIndex: number
Gets or sets the ZIndex of the Graphic2d. The ZIndex is used to control draw order. Higher ZIndexes appear above lower ZIndexed graphics.
Visible: boolean
Gets or sets the Visible property. The Visible property determines whether the renderable will be drawn to the game screen.
Position: EndGate.Vector2d
Gets or sets the Position of the Graphic2d. The Position determines where the graphic will be drawn on the screen.
Rotation: number
Gets or sets the Rotation of the Graphic2d..
AbsolutePosition: EndGate.Vector2d
Gets the absolute position of the Graphic2d. This is used to calculate absolute positions when graphic's have parents.
OnDisposed: EndGate.EventHandler1 <Graphic2d>
Gets an event that is triggered when the Graphic2d has been disposed. Functions can be bound or unbound to this event to be executed when the event triggers.
Opacity: number
Gets or sets the current opacity. Value is between 0 and 1.
Methods
Draw()
Draws the line onto the given context. If this Line2d is part of a scene the Draw function will be called automatically.
GetDrawBounds()
The bounding area that represents where the Line2d will draw.
Scale()
Scale's the Line2d graphic.
Clone()
Returns a nearly identical copy of this Line2d. If this Line2d belongs to a parent, the cloned Line2d will not. If this Line2d has children, all children will be cloned as well. Lastly, the cloned Line2d will not have the same event bindings as this one does.
Inherited from: Graphics.Graphic2d
GetChildren()
Returns the list of children for the current Graphic2d.
AddChild()
Adds a child to the Graphic2d. Children are drawn with relative positions to the parent Graphic2d. Children of a Graphic2d should not be added to the Scene, parent Graphic2d's are responsible for drawing their children.
RemoveChild()
Removes a child from the Graphic2d. Returns a Boolean value indicating whether or not the child was able to be removed.
Dispose()
Triggers the OnDisposed event. If this Graphic2d is used with a Scene2d it will be removed from the scene when disposed.
Examples
There's currently no example available for this page. If you'd like to suggest one send me an containing a description, code, and link to the page for the suggested example. As a thanks I'll associate the code snippet with your name directly below the example if approved.