Class DisplayList

A set of DisplayObject's, which show the state of the simulation. A DisplayObject typically represents a SimObject, but not always.

zIndex

DisplayObjects with a lower zIndex appear underneath those with higher zIndex. The DisplayList is sorted by zIndex. See DisplayObject.getZIndex.

Hierarchy (view full)

AbstractSubject
- DisplayList

Implements

Subject

Constructors

constructor

new DisplayList(opt_name?): DisplayList
Parameters
- Optional opt_name: string
  name of this DisplayList.
Returns DisplayList
Overrides AbstractSubject.constructor
- Defined in lab/view/DisplayList.ts:40

Properties

`Static` `Readonly` OBJECT_ADDED

OBJECT_ADDED: "OBJECT_ADDED" = 'OBJECT_ADDED'

Name of event broadcast when a DisplayObject is added, see add, prepend.

`Static` `Readonly` OBJECT_REMOVED

OBJECT_REMOVED: "OBJECT_REMOVED" = 'OBJECT_REMOVED'

Name of event broadcast when a DisplayObject is removed, see remove, removeAll.

Methods

add

add(...dispObjs): void
Adds the DisplayObject, inserting it at the end of the group of DisplayObjects with the same zIndex; the item will appear visually over objects that have the same (or lower) zIndex.
Parameters
- Rest ...dispObjs: DisplayObject[]
  the DisplayObject's to add
Returns void
- Defined in lab/view/DisplayList.ts:68

addObserver

addObserver(observer): void
Adds the given Observer to this Subject's list of Observers, so that the Observer will be notified of changes in this Subject. An Observer may call Subject.addObserver during its observe method.
Parameters
- observer: Observer
  the Observer to add
Returns void
Implementation of Subject.addObserver
Inherited from AbstractSubject.addObserver
- Defined in lab/util/AbstractSubject.ts:67

addParameter

addParameter(parameter): void
Adds the Parameter to the list of this Subject's available Parameters.
Parameters
- parameter: Parameter
  the Parameter to add
Returns void
Throws
if a Parameter with the same name already exists.
Inherited from AbstractSubject.addParameter
- Defined in lab/util/AbstractSubject.ts:100

broadcast

broadcast(evt): void
Notifies all Observers that this Subject has changed by calling observe on each Observer.

An Observer may call addObserver or removeObserver during its observe method.
Parameters
- evt: SubjectEvent
  a SubjectEvent with information relating to the change
Returns void
Implementation of Subject.broadcast
Inherited from AbstractSubject.broadcast
- Defined in lab/util/AbstractSubject.ts:110

broadcastParameter

broadcastParameter(name): void
Notifies all Observers that the Parameter with the given name has changed by calling observe on each Observer.
Parameters
- name: string
  the language-independent or English name of the Parameter that has changed
Returns void
Throws
if there is no Parameter with the given name
Implementation of Subject.broadcastParameter
Inherited from AbstractSubject.broadcastParameter
- Defined in lab/util/AbstractSubject.ts:132

contains

contains(dispObj): boolean
Returns true if this DisplayList contains the given DisplayObject.
Parameters
- dispObj: DisplayObject
  the item to search for
Returns boolean
true if the DisplayObject was found
- Defined in lab/view/DisplayList.ts:93

draw

draw(context, map): void
Draws the DisplayObjects in order, which means that DisplayObjects drawn later (at the end of the list) will appear to be on top of those drawn earlier (at start of the list).
Parameters
- context: CanvasRenderingContext2D
  the canvas's context to draw this object into
- map: CoordMap
  the mapping to use for translating between simulation and screen coordinates
Returns void
- Defined in lab/view/DisplayList.ts:107

find

find(search): undefined | DisplayObject
Returns the DisplayObject that shows the given SimObject.
Parameters
- search: string | number | SimObject
  the SimObject to search for, or name of SimObject, or index number of DisplayObject. Name should be English or language-independent version of name.
Returns undefined | DisplayObject
the DisplayObject on this list that shows the given SimObject, or undefined if not found
- Defined in lab/view/DisplayList.ts:119

findShape

findShape(search): DisplayShape
Returns the DisplayShape that shows the given SimObject.
Parameters
- search: string | number | SimObject
  the SimObject to search for, or name of SimObject, or index number of DisplayObject. Name should be English or language-independent version of name.
Returns DisplayShape
the DisplayShape on this list that shows the given SimObject

Throws
if DisplayShape is not found
- Defined in lab/view/DisplayList.ts:161

findSpring

findSpring(search): DisplaySpring
Returns the DisplaySpring that shows the given SimObject.
Parameters
- search: string | number | SimObject
  the SimObject to search for, or name of SimObject, or index number of DisplayObject. Name should be English or language-independent version of name.
Returns DisplaySpring
the DisplaySpring on this list that shows the given SimObject

Throws
if DisplaySpring is not found
- Defined in lab/view/DisplayList.ts:177

get

get(index): DisplayObject
Returns the DisplayObject at the specified position in this DisplayList
Parameters
- index: number
  index number of DisplayObject
Returns DisplayObject
the DisplayObject at the specified position in this DisplayList

Throws
if index out of range
- Defined in lab/view/DisplayList.ts:191

`Protected` getBroadcast

getBroadcast(): boolean
Returns whether broadcasting is enabled for this Subject. See setBroadcast.

Returns boolean
whether broadcasting is enabled for this Subject
Inherited from AbstractSubject.getBroadcast
- Defined in lab/util/AbstractSubject.ts:144

getChanged

getChanged(): boolean
Returns true if any DisplayObject on this DisplayList has changed, and sets the state to "unchanged".

Returns boolean
whether any DisplayObject on this DisplayList this DisplayObject has changed
- Defined in lab/view/DisplayList.ts:205

getClassName

getClassName(): string
Returns name of class of this object.

Returns string
name of class of this object.
Overrides AbstractSubject.getClassName
- Defined in lab/view/DisplayList.ts:59

getName

getName(): string
Return the language-independent name of this Subject for scripting purposes.

Returns string
name the language-independent name of this Subject
Implementation of Subject.getName
Inherited from AbstractSubject.getName
- Defined in lab/util/AbstractSubject.ts:154

getObservers

getObservers(): Observer[]
Returns a copy of the list of Observers of this Subject.

Returns Observer[]
a copy of the list of Observers of this Subject.
Implementation of Subject.getObservers
Inherited from AbstractSubject.getObservers
- Defined in lab/util/AbstractSubject.ts:159

getParameter

getParameter(name): Parameter
Returns the Parameter with the given name.
Parameters
- name: string
  the language-independent or English name of the Parameter
Returns Parameter
the Parameter with the given name

Throws
if there is no Parameter with the given name
Implementation of Subject.getParameter
Inherited from AbstractSubject.getParameter
- Defined in lab/util/AbstractSubject.ts:173

getParameterBoolean

getParameterBoolean(name): ParameterBoolean
Returns the ParameterBoolean with the given name.
Parameters
- name: string
  the language-independent or English name of the ParameterBoolean
Returns ParameterBoolean
the ParameterBoolean with the given name

Throws
if there is no ParameterBoolean with the given name
Implementation of Subject.getParameterBoolean
Inherited from AbstractSubject.getParameterBoolean
- Defined in lab/util/AbstractSubject.ts:182

getParameterNumber

getParameterNumber(name): ParameterNumber
Returns the ParameterNumber with the given name.
Parameters
- name: string
  the language-independent or English name of the ParameterNumber
Returns ParameterNumber
the ParameterNumber with the given name

Throws
if there is no ParameterNumber with the given name
Implementation of Subject.getParameterNumber
Inherited from AbstractSubject.getParameterNumber
- Defined in lab/util/AbstractSubject.ts:191

getParameterString

getParameterString(name): ParameterString
Returns the ParameterString with the given name.
Parameters
- name: string
  the language-independent or English name of the ParameterString
Returns ParameterString
the ParameterString with the given name

Throws
if there is no ParameterString with the given name
Implementation of Subject.getParameterString
Inherited from AbstractSubject.getParameterString
- Defined in lab/util/AbstractSubject.ts:200

getParameters

getParameters(): Parameter[]
Returns a copy of the list of this Subject's available Parameters.

Returns Parameter[]
a copy of the list of available Parameters for this Subject
Implementation of Subject.getParameters
Inherited from AbstractSubject.getParameters
- Defined in lab/util/AbstractSubject.ts:209

length

length(): number
Returns number of DisplayObjects in this DisplayList, minus 1.

Returns number
number of DisplayObjects minus 1
- Defined in lab/view/DisplayList.ts:221

prepend

prepend(dispObj): void
Adds the DisplayObject, inserting it at the front of the group of DisplayObjects with the same zIndex; the item will appear visually under objects that have the same (or higher) zIndex.
Parameters
- dispObj: DisplayObject
  the DisplayObject to prepend
Returns void
- Defined in lab/view/DisplayList.ts:246

remove

remove(dispObj): void
Removes the item from the list of DisplayObjects.
Parameters
- dispObj: DisplayObject
  the item to remove
Returns void
- Defined in lab/view/DisplayList.ts:275

removeAll

removeAll(): void
Clears the list of DisplayObjects.

Returns void
- Defined in lab/view/DisplayList.ts:289

removeObserver

removeObserver(observer): void
Removes the Observer from this Subject's list of Observers. An Observer may call removeObserver during its observe method.
Parameters
- observer: Observer
  the Observer to detach from list of Observers
Returns void
Implementation of Subject.removeObserver
Inherited from AbstractSubject.removeObserver
- Defined in lab/util/AbstractSubject.ts:214

removeParameter

removeParameter(parameter): void
Removes the Parameter from the list of this Subject's available Parameters.
Parameters
- parameter: Parameter
  the Parameter to remove
Returns void
Inherited from AbstractSubject.removeParameter
- Defined in lab/util/AbstractSubject.ts:226

`Protected` setBroadcast

setBroadcast(value): boolean
Sets whether this Subject will broadcast events, typically used to temporarily disable broadcasting. Intended to be used in situations where a subclass overrides a method that broadcasts an event. This allows the subclass to prevent the superclass broadcasting that event, so that the subclass can broadcast the event when the method is completed.
Parameters
- value: boolean
  whether this Subject should broadcast events
Returns boolean
the previous value
Inherited from AbstractSubject.setBroadcast
- Defined in lab/util/AbstractSubject.ts:238

sort

sort(): void
Sorts the DisplayList by zIndex. Avoids sorting if the list is already sorted.

Returns void
- Defined in lab/view/DisplayList.ts:295

toArray

toArray(): DisplayObject[]
Returns set of the DisplayObjects in proper visual sequence, starting with the bottom-most object.

Returns DisplayObject[]
list of DisplayObjects in visual sequence order
- Defined in lab/view/DisplayList.ts:327

toString

toString(): string
Returns string
Inherit Doc
Overrides AbstractSubject.toString
- Defined in lab/view/DisplayList.ts:45

toStringShort

toStringShort(): string
Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:
```
DisplayShape{polygon:Polygon{'chain3'}}
```
Returns string
a minimal string representation of this object.
Implementation of Subject.toStringShort
Overrides AbstractSubject.toStringShort
- Defined in lab/view/DisplayList.ts:53

Class DisplayList

zIndex

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opt_name: string

Returns DisplayList

Properties

Static Readonly OBJECT_ADDED

Static Readonly OBJECT_REMOVED

Methods

add

Parameters

Rest ...dispObjs: DisplayObject[]

Returns void

addObserver

Parameters

observer: Observer

Returns void

addParameter

Parameters

parameter: Parameter

Returns void

Throws

broadcast

Parameters

evt: SubjectEvent

Returns void

broadcastParameter

Parameters

name: string

Returns void

Throws

contains

Parameters

dispObj: DisplayObject

Returns boolean

draw

Parameters

context: CanvasRenderingContext2D

map: CoordMap

Returns void

find

Parameters

search: string | number | SimObject

Returns undefined | DisplayObject

findShape

Parameters

search: string | number | SimObject

Returns DisplayShape

Throws

findSpring

Parameters

search: string | number | SimObject

Returns DisplaySpring

Throws

get

Parameters

index: number

Returns DisplayObject

Throws

Protected getBroadcast

Returns boolean

getChanged

Returns boolean

getClassName

Returns string

getName

Returns string

getObservers

Returns Observer[]

getParameter

Parameters

name: string

`Optional` opt_name: string

`Static` `Readonly` OBJECT_ADDED

`Static` `Readonly` OBJECT_REMOVED

`Rest` ...dispObjs: DisplayObject[]

`Protected` getBroadcast

`Protected` setBroadcast