Home Reference Source
import RectangleShape from 'oxygen-core/components/RectangleShape.js'
public class | source

RectangleShape

Extends:

ComponentShape → RectangleShape

Static Member Summary

Static Public Members
public static get

propsTypes: {...undefined: Object, "width": string, "height": string, "xOffset": string, "yOffset": string, "xOrigin": string, "yOrigin": string}

Static Method Summary

Static Public Methods
public static

factory(): *

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

height: *

public set
public get

width: *

public set
public get

xOffset: *

public set
public get

xOrigin: *

public set
public get

yOffset: *

public set
public get

yOrigin: *

public set

Method Summary

Public Methods
public

containsPoint(globalPoint: *, layer: undefined): *

Inherited Summary

From class Component
public static get
public static

Component factory.

public get
public

[name]: *

public

deserialize(json: *)

Deserialize JSON properties into this component.

public

Destructor (dispose internal resources and detach from entity).

public

onAction(name: string, args: *)

Called when action arrived.

public

onAlterActionArguments(name: string, args: *): array | undefined

Called when asked to alter arrived action parameters.

public

Called after attached to entity.

public

Called before detached from entity.

public

onPropertySerialize(name: string, value: *): *

Called when property is serialized.

public

onPropertySetup(name: string, value: *)

Called when given property is deserialized.

public

serialize(): *

Serialize component into JSON data.

From class Shape
public static get

propsTypes: {"layers": string}

public static

factory(): *

public get
public set
public

acceptsLayer(name: *): *

public

containsPoint(globalPoint: *, layer: undefined)

public

containsPointInChildren(globalPoint: *, layer: undefined): *

public

Static Public Members

public static get propsTypes: {...undefined: Object, "width": string, "height": string, "xOffset": string, "yOffset": string, "xOrigin": string, "yOrigin": string} source

Override:

Shape#propsTypes

Static Public Methods

public static factory(): * source

Component factory.

Override:

Shape#factory

Return:

*

Public Constructors

public constructor() source

Constructor.

Override:

Shape#constructor

Public Members

public get height: * source

public set height source

public get width: * source

public set width source

public get xOffset: * source

public set xOffset source

public get xOrigin: * source

public set xOrigin source

public get yOffset: * source

public set yOffset source

public get yOrigin: * source

public set yOrigin source

Public Methods

public containsPoint(globalPoint: *, layer: undefined): * source

Override:

Shape#containsPoint

Params:

NameTypeAttributeDescription
globalPoint *
layer undefined
  • optional
  • default: undefined

Return:

*