Class DisplayConnector

Shows the location of a Connector as a small colored circle. The radius is specified in screen coordinates, so the size of the circle stays the same regardless of the zoom level on the SimView.

The position is determined by the position of the Connector, so setPosition has no effect, and the DisplayConnector is never dragable.

Implements

Constructors

constructor

Properties

color_ radius_

Methods

contains draw getChanged getColor getMassObjects getPosition getRadius getSimObjects getZIndex isDragable setColor setDragable setPosition setRadius setZIndex toString toStringShort

Constructors

constructor

Properties

Private color_

color_: undefined | string

Color to draw the joint, a CSS3 color value.

Private radius_

radius_: undefined | number

Radius of circle to draw, in screen coordinates.

Methods

contains

  • contains(_p_world): boolean

  • Whether the DisplayObject contains the given world coordinates point.

    Parameters

    • _p_world: Vector

      the point in world coordinates

    Returns boolean

    true if this DisplayObject contains the given point

draw

  • draw(context, map): void

  • Draws this DisplayObject using the given CoordMap.

    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

getChanged

getColor

getMassObjects

getPosition

getRadius

getSimObjects

getZIndex

  • getZIndex(): number

  • Sets the z-index which specifies front-to-back ordering of objects; objects with a higher zIndex are drawn over (in front of) objects with a lower zIndex.

    Returns number

    the zIndex of this DisplayObject

isDragable

setColor

setDragable

  • setDragable(_dragable): void

  • Sets whether this DisplayObject is currently dragable; has no effect on objects that are not dragable.

    Parameters

    • _dragable: boolean

      whether this DisplayObject should be dragable

    Returns void

setPosition

  • setPosition(_position): void

  • Sets this DisplayObject's position in simulation coordinates of the containing SimView. Each type of DisplayObject has a different policy regarding whether this will have an effect. Generally the policies are:

    • If the DisplayObject does not represent a SimObject, then the position can be set. Examples are DisplayClock, EnergyBarGraph.

    • If the SimObject's position is dependent on other objects, then the position cannot be set. Examples are DisplayConnector, DisplayRope, DisplaySpring.

    • If the SimObject can be moved independently and isDragable is true, then the position of the SimObject is modified. Example: DisplayShape.

    Parameters

    • _position: GenericVector

      this DisplayObject's position, in simulation coordinates.

    Returns void

setRadius

setZIndex

  • setZIndex(zIndex): void

  • Sets the z-index which specifies front-to-back ordering of objects; objects with a higher zIndex are drawn over objects with a lower zIndex. Default is zero.

    Parameters

    • zIndex: number

      the zIndex of this DisplayObject

    Returns void

toString

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc