API Docs for: v2.1.0
Show:

CGSGSceneGraph Class

Extends Object
Defined in: src\class.scenegraph.js:26
Module: Scene

Represent the scene graph it self.

Constructor

CGSGSceneGraph

(
  • canvas
  • context
)

Defined in src\class.scenegraph.js:26

Parameters:

  • canvas HTMLElement

    a handler to the canvas HTML element

  • context CanvasRenderingContext2D

    context to render on

Methods

_invalidateThemeRecursive

(
  • n
)
private

Defined in src\class.scenegraph.js:101

Parameters:

addNode

(
  • node
  • parent
)

Defined in src\class.scenegraph.js:349

Add a node on the scene. If the root does not already exist, this node will be used as root

Parameters:

  • node CGSGNode

    the node to add

  • parent CGSGNode

    the parent node of the new one. If it's null, the node will be the root.

deselectAll

(
  • excludedArray
)

Defined in src\class.scenegraph.js:255

Mark all nodes as not selected

Parameters:

  • excludedArray Array

    CGSGNodes to not deselect

deselectNode

(
  • nodeToDeselect
)

Defined in src\class.scenegraph.js:244

Mark the nodes as not selected

Parameters:

initializeGhost

(
  • w
  • h
)
private

Defined in src\class.scenegraph.js:79

Initialize the ghost rendering, used by the PickNode function

Parameters:

  • w Number

    width The width for the canvas. Must be the same as the rendering canvas

  • h Number

    height The height for the canvas. Must be the same as the rendering canvas

invalidateTheme

()

Defined in src\class.scenegraph.js:93

Used to enforce theme invalidation for each node during next rendering loop

pickNode

(
  • mousePosition
  • condition
)
CGSGNode

Defined in src\class.scenegraph.js:273

Recursively traverse the nodes and return the one who is under the mouse coordinates

Parameters:

Returns:

CGSGNode:

Example:

this.scenegraph.picknode(mousePosition, 'position.x > 100');
this.scenegraph.picknode(mousePosition, 'position.x > 100 && this.position.y > 100');

pickNodes

(
  • region
  • condition
)
Array

Defined in src\class.scenegraph.js:303

Recursively traverse the nodes and return the ones who are under the mouse coordinates

Parameters:

Returns:

Array:

Example:

this.scenegraph.picknodes(region, 'position.x > 100');
this.scenegraph.picknodes(region, 'position.x > 100 && this.position.y > 100');

removeNode

(
  • node
)
Boolean

Defined in src\class.scenegraph.js:333

Remove the child nodes passed in parameter, from the root nodes

Parameters:

Returns:

Boolean:

true if the nodes was found and removed

render

() public

Defined in src\class.scenegraph.js:116

Render the SceneGraph

selectNode

(
  • nodeToSelect
)

Defined in src\class.scenegraph.js:230

Mark the nodes as selected so the select marker (also called selectedHandlers) will be shown and the SceneGraph will manage the moving and resizing of the selected objects.

Parameters:

  • nodeToSelect Object

    The CGSGNode to be selected

setCanvasDimension

(
  • newDimension
)

Defined in src\class.scenegraph.js:219

Change the dimension of the canvas. Does not really change the dimension of the rendering canvas container, but is used for different computations

Parameters:

String.prototype.addFirstDot

() String

Provided by the Util module.

Defined in src\utils\util.string.js:53

Add a dot ('.') as first character if it's not already a dot

Returns:

String:

A String with the first '.'

String.prototype.capitalize

(
  • lower
)
String

Provided by the Util module.

Defined in src\utils\util.string.js:65

Capitalize first letter of the String

Parameters:

  • lower Boolean

    if true, all other letters will be lowercased

Returns:

String:

String.prototype.collapse

() String

Provided by the Util module.

Defined in src\utils\util.string.js:38

Return same String by replacing space, dot and minus by the following letter uppercased

Returns:

String:

String.prototype.without

(
  • t
)
String

Provided by the Util module.

Defined in src\utils\util.string.js:27

Return same String without string in parameter

Parameters:

Returns:

String:

Properties

_nextNodeID

Number private

Defined in src\class.scenegraph.js:55

context

CanvasRenderingContext2D

Defined in src\class.scenegraph.js:49

ghostCanvas

HTMLElement

Defined in src\class.scenegraph.js:65

Initialize a ghost canvas used to determine which nodes are selected by the user

root

CGSGNode

Defined in src\class.scenegraph.js:42

Root node of the graph