Class: DisplayObject

PhotoEditorSDK.Engine~ DisplayObject

The base class for all objects that can be displayed on the screen

new DisplayObject()

sdk/core/engine/display/display-object.js, line 28

Creates a DisplayObject

Methods

addShader(shader)

sdk/core/engine/display/display-object.js, line 108

Pushes the given shader to the list of shaders

Name Type Description
shader PhotoEditorSDK.Engine.Shader

getAlpha(){Number}

sdk/core/engine/display/display-object.js, line 232

Returns the current alpha (0...1)

Returns:
Type Description
Number

getBounds(){PhotoEditorSDK.Math.Rectangle}

sdk/core/engine/display/display-object.js, line 143

Returns the bounds for this DisplayObject

Returns:
Type Description
PhotoEditorSDK.Math.Rectangle

getFilterRectangle(){PhotoEditorSDK.Math.Rectangle}

sdk/core/engine/display/display-object.js, line 274

Returns the filter rectangle

Returns:
Type Description
PhotoEditorSDK.Math.Rectangle rectangle

getParent(){PhotoEditorSDK.Engine.DisplayObject}

sdk/core/engine/display/display-object.js, line 262

Returns the parent object

Returns:
Type Description
PhotoEditorSDK.Engine.DisplayObject

getPivot(){PhotoEditorSDK.Math.Vector2}

sdk/core/engine/display/display-object.js, line 195

Returns the current pivot (The point that this Displayobject rotates around)

Returns:
Type Description
PhotoEditorSDK.Math.Vector2

getPosition(){PhotoEditorSDK.Math.Vector2}

sdk/core/engine/display/display-object.js, line 153

Returns the current position

Returns:
Type Description
PhotoEditorSDK.Math.Vector2

getRotation(){Number}

sdk/core/engine/display/display-object.js, line 216

Returns the current rotation in radians

Returns:
Type Description
Number

getScale(){PhotoEditorSDK.Math.Vector2}

sdk/core/engine/display/display-object.js, line 174

Returns the current scale

Returns:
Type Description
PhotoEditorSDK.Math.Vector2

getTint(){Number}

sdk/core/engine/display/display-object.js, line 290

Returns the current tint color

Returns:
Type Description
Number

getWorldAlpha(){Number}

sdk/core/engine/display/display-object.js, line 244

Returns the computed alpha of this DisplayObject

Returns:
Type Description
Number

getWorldTransform(){PhotoEditorSDK.Math.Matrix}

sdk/core/engine/display/display-object.js, line 256

Returns the current world transformation matrix

Returns:
Type Description
PhotoEditorSDK.Math.Matrix

isVisible(){Boolean}

sdk/core/engine/display/display-object.js, line 302

Checks whether this object is currently visible or not

Returns:
Type Description
Boolean [description]

removeShader(shader){Boolean}

sdk/core/engine/display/display-object.js, line 117

Removes the given shader from the list of shaders

Name Type Description
shader PhotoEditorSDK.Engine.Shader
Returns:
Type Description
Boolean

removeShaderAt(index){Boolean}

sdk/core/engine/display/display-object.js, line 131

Removes the shader at the given index from the list of shaders

Name Type Description
index Number
Returns:
Type Description
Boolean

abstractrenderCanvas(renderer)

sdk/core/engine/display/display-object.js, line 61

Renders this DisplayObject using the given CanvasRenderer

Name Type Description
renderer PhotoEditorSDK.Engine.CanvasRenderer

abstractrenderWebGL(renderer)

sdk/core/engine/display/display-object.js, line 52

Renders this DisplayObject using the given WebGLRenderer

Name Type Description
renderer PhotoEditorSDK.Engine.WebGLRenderer

setAlpha(alpha)

sdk/core/engine/display/display-object.js, line 238

Sets the alpha (0...1)

Name Type Description
alpha Number

setFilterRectangle(rectangle)

sdk/core/engine/display/display-object.js, line 282

Sets the filter rectangle

Name Type Description
rectangle PhotoEditorSDK.Math.Rectangle

setParent(parent)

sdk/core/engine/display/display-object.js, line 268

Sets this object's parent object

Name Type Description
parent PhotoEditorSDK.Engine.DisplayObject

setPivot(pivot, y)

sdk/core/engine/display/display-object.js, line 202

Sets the pivot (The point that this DisplayObject rotates around)

Name Type Description
pivot PhotoEditorSDK.Math.Vector2 | Number
y Number optional

setPosition(x, y)

sdk/core/engine/display/display-object.js, line 160

Sets the position to the given one

Name Type Description
x PhotoEditorSDK.Math.Vector2 | Number
y Number optional

setRotation(rotation)

sdk/core/engine/display/display-object.js, line 222

Sets this object's rotation (in radians)

Name Type Description
rotation Number

setScale(x, y)

sdk/core/engine/display/display-object.js, line 181

Sets the scale to the given one

Name Type Description
x PhotoEditorSDK.Math.Vector2 | Number
y Number optional

setTint(tint)

sdk/core/engine/display/display-object.js, line 296

Sets the tint color

Name Type Description
tint Number

setVisible(visible)

sdk/core/engine/display/display-object.js, line 308

Sets this object's visibility

Name Type Description
visible Boolean

updateTransform()

sdk/core/engine/display/display-object.js, line 68

Updates the world transform for this DisplayObject