Square
Class representing a Square, extending the Rectangle class. Provides functionality for rendering, resizing, moving, and rotating the square.
Extends
Constructors
new Square()
new Square(
x,y,size,rotation,style?,options?):Square
Constructs a new Square instance.
Parameters
• x: number
The x-coordinate of the square's position.
• y: number
The y-coordinate of the square's position.
• size: number
The size (width/height) of the square.
• rotation: number = 0
The initial rotation of the square in degrees clockwise.
• style?: IRectangleStyle
The style options for the square.
• options?: IRectangleOptions
The configuration options for the square.
Returns
Overrides
Defined in
Properties
_definition
protected_definition:RectangleDefinition
The shape definition, proxied to trigger observer notifications on change.
Inherited from
Defined in
_options
protected_options:RectangleOptions
The options for configuring the shape, proxied to trigger observer notifications on change.
Inherited from
Defined in
_state
protected_state:ShapeState=ShapeState.Default
The current state of the shape, representing its visual or interactive status.
Inherited from
Defined in
_style
protected_style:RectangleStyle
The style settings for the shape, proxied to trigger observer notifications on change.
Inherited from
Defined in
observers
protectedobservers: () =>void[] =[]
List of observer functions to be notified on shape changes.
Inherited from
Defined in
Accessors
angle
getangle():Angle
Gets the angle of the rectangle.
Returns
The angle (rotation) of the rectangle.
Inherited from
Defined in
height
getheight():number
Gets the height of the square.
setheight(height):void
Sets the height of the square and updates the width with same value.
Parameters
• height: number
The new height of the square.
Returns
number
The height of the square.
Overrides
Defined in
options
getoptions():TOptions
Gets the configuration options of the shape.
setoptions(options):void
Updates the configuration options of the shape and notifies observers.
Parameters
• options: TOptions
The new options to apply.
Returns
TOptions
The current options.
Inherited from
Defined in
position
getposition():Point
Gets the position (Point) of the rectangle.
setposition(position):void
Sets the position (Point) of the rectangle.
Parameters
• position: Point
The new position of the rectangle.
Returns
The position of the rectangle.
Inherited from
Defined in
rotation
getrotation():number
Gets the rotation of the rectangle in degrees.
setrotation(rotation):void
Sets the rotation of the rectangle.
Parameters
• rotation: number
The new rotation of the rectangle.
Returns
number
The rotation of the rectangle.
Inherited from
Defined in
size
getsize():number
Gets the size (widht/height) of the square.
setsize(size):void
Sets the size (width/height) of the square.
Parameters
• size: number
The new size of the square.
Returns
number
The size of the square.
Defined in
state
getstate():ShapeState
Gets the current state of the shape.
setstate(state):void
Sets a new state for the shape.
Parameters
• state: ShapeState
The new state to assign to the shape.
Returns
The current state of the shape.
Inherited from
Defined in
stateStyle
getstateStyle():TStyle
Retrieves the effective style of the shape based on its current state.
Returns
TStyle
The computed style object for the current shape state, with state-specific overrides merged in as necessary.
Inherited from
Defined in
style
getstyle():TStyle
Gets the style settings of the shape.
setstyle(style):void
Updates the style settings of the shape and notifies observers.
Parameters
• style: TStyle
The new style settings to apply.
Returns
TStyle
The current style settings.
Inherited from
Defined in
width
getwidth():number
Gets the width of the square.
setwidth(width):void
Sets the width of the square and updates the height with same value.
Parameters
• width: number
The new width of the square.
Returns
number
The width of the square.
Overrides
Defined in
Methods
addObserver()
addObserver(
observer):void
Adds an observer function that will be called when the shape's state changes.
Parameters
• observer
The observer callback function.
Returns
void
Inherited from
Defined in
hasBorder()
protectedhasBorder():boolean
Determines if the current state style includes a visible border.
Returns
boolean
true if borderColor and borderWidth are defined and indicate a visible border; otherwise, false.
Inherited from
Defined in
hide()
hide():
void
Hides the shape, preventing it from being rendered on the canvas.
The shape will still exist and retain its properties, but it will not
appear during rendering until show() is called.
Returns
void
Inherited from
Defined in
isMouseOver()
isMouseOver(
mousePosition):boolean
Determines if the mouse is currently over the shape.
Parameters
• mousePosition: Point
The current mouse position.
Returns
boolean
True if the mouse is over the shape, false otherwise.
Inherited from
Defined in
isVisible()
isVisible():
boolean
Checks whether the shape is currently visible.
Returns
boolean
Returns true if the shape is visible and will be rendered on the canvas. Returns false if the shape is hidden and will not be rendered.
Inherited from
Defined in
move()
move(
deltaX,deltaY):void
Moves the rectangle by adjusting the current position by delta values.
Parameters
• deltaX: number = 0
The change in the x-coordinate.
• deltaY: number = 0
The change in the y-coordinate.
Returns
void
Inherited from
Defined in
removeObserver()
removeObserver(
observer):void
Removes a previously added observer function.
Parameters
• observer
The observer callback function to be removed.
Returns
void
Inherited from
Defined in
render()
render(
context):void
Renders the rectangle on the canvas using the provided 2D rendering context.
The rectangle will be rendered with its current position, size, and rotation.
Parameters
• context: CanvasRenderingContext2D
The 2D rendering context of the canvas where the rectangle will be drawn.
Returns
void
Inherited from
Defined in
resize()
resize(
deltaSize):void
Resizes the rectangle by adjusting the current size, width and height by delta value.
Parameters
• deltaSize: number
The change in width.
Returns
void
Overrides
Defined in
rotate()
rotate(
deltaRotation):void
Rotates the rectangle by adjusting its current angle.
Parameters
• deltaRotation: number
The amount to adjust the rectangle's rotation, in degrees.
Returns
void
Inherited from
Defined in
setSize()
setSize(
size):void
Updates the size of the square by setting new width and height values.
Parameters
• size: number
The new width and height of the square.
Returns
void
Overrides
Defined in
show()
show():
void
Makes the shape visible, allowing it to be rendered on the canvas. If the shape was previously hidden, calling this method will make it appear during the next rendering cycle.
Returns
void
Inherited from
Defined in
toArray()
toArray():
any[]
Converts the shape's definition to an array.
Returns
any[]
An array representation of the shape's definition.
Inherited from
Defined in
toJson()
toJson():
string
Converts the shape's definition to a JSON string.
Returns
string
A JSON string representation of the shape's definition.