import Ball from 'newton-lib/src/elements/Ball.js'

public class | source

Ball

Extends:

WorldElement → Ball

The Ball class is a particle class used to draw round particles with the advantage that they can be labeled and displayed with a gradient, giving a more realistic feel to the particle.

Static Method Summary

Static Public Methods
public static	getChargeColor(charge: number): string Gets a color depending on the value a charge has.
public static	getChargeSign(charge: number): string Gets the sign a charge must have depending on the value a charge has.

Constructor Summary

Public Constructor
public	constructor(r: number, opts: object)

Member Summary

Public Members
public	gradient: boolean Flag for enabling a gradient on the ball.
public	isDraggable: boolean Flag for allowing the ball to be dragged around.
public	lowerLabel: string Spot for writing a label on the ball.
public	r: number Radius of the ball in units.
public	topmostOnDrag: boolean Flag for allowing the ball to become a topmost object when its beging dragged, Default value is true.
public	upperLabel: string Upper spot for writing a label on the bal..

Method Summary

Private Methods
private	draw() Main draw function for the ball called by the World automatically.
private	isMouseOver(): boolean Tests if the mouse is over the ball.

Inherited Summary

From class WorldElement
public	color: string Sets the color in HEX format of the element.
public	cursor: string Sets the cursor style when the mouse is over the element.
public	display: boolean Flag for enabling or diabling this element.
public	dragging: boolean Flag set when the element is being dragged around.
public	font: Font Sets the font of the element.
public	height: number Sets the current height of the element.
public	isDraggable: boolean Flag for allowing the element to be dragged around.
public	mouseMoveStyle: string Sets the move style of the element.
public	mouseOver: boolean Flag set when the mouse is over the element.
public	onMouseMove: function Sets a callback function for when the element is dragged around.
public	position: object Sets the position of the element.
public	renderer: Renderer Sets the renderer used for the element.
public	rotation: number Sets the rotation of the element.
public	savedZIndex: number A copy of the z-index value is stored here.
public	scale: number Sets the drawing scale of the element.
public	topmostOnDrag: boolean Flag for determining if the element will be a top-most element when dragged around.
public	valid: boolean Flag used to determine if an object is a child of WorldElement.
public	width: number Sets the current width of the element.
public	world: World Sets the world where this element is found.
public	zIndex: number Sets the z-index of the element.
public	addPosition(x: number, y: number) Adds the provided coordinates to the position.
public	draggable(s: boolean) Sets if the element is draggable.
public	isMouseOver(): boolean Function called when the mouse moves to check if the pointer is over the element.
public	setColor(c: string) Sets the color in HEX format of the element.
public	setPosition(x: number, y: number) Sets the position of the element.
public	setScale(s: number) Sets the scale of the element.
public	setZ(z: number) Sets the z-index of the element.
private	resize() Function called when the canvas gets resized.
private	setWorld(world: World) Sets the world object where element will be drawn.
private	topmost(state: boolean) Sets the element as a topmost element.

Static Public Methods

public static getChargeColor(charge: number): string source

Gets a color depending on the value a charge has. If the charge is positive the color is COLORS.RED. If the charge is negative the color is COLORS.BLUE. If the charge is neutral the color is COLORS.GRAY.

Params:

Name	Type	Attribute	Description
charge	number		Charge of the particle in coulombs.

Return:

string

Color for the charge.

public static getChargeSign(charge: number): string source

Gets the sign a charge must have depending on the value a charge has. If the charge is positive the sign is "+". If the charge is negative the sign is "-". If the charge is neutral the sign is "".

Params:

Name	Type	Attribute	Description
charge	number		Charge of the particle in coulombs.

Return:

string

Sign for the charge.

Public Constructors

public constructor(r: number, opts: object) source

Override:

WorldElement#constructor

Params:

Name	Type	Attribute	Description
r	number	optional default: 1	Radius of the charge in units.
opts	object	optional	Object that contains valid Ball properties with values. Their values will be assigned at the end of the constructor. If an invalid property is passed then the value will be ignored.

Public Members

public gradient: boolean source

Flag for enabling a gradient on the ball. The color used for gradient is the one set in Ball.color. Default value is true.

public isDraggable: boolean source

Flag for allowing the ball to be dragged around. Default value is true.

Override:

WorldElement#isDraggable

public lowerLabel: string source

Spot for writing a label on the ball. If the Ball.upperLabel is blank, then the lower label will be centered on the particle. If not, then it will be the lower label on the ball. Default value is "".

public r: number source

Radius of the ball in units. Default value is 1.

public topmostOnDrag: boolean source

Flag for allowing the ball to become a topmost object when its beging dragged, Default value is true.

Override:

WorldElement#topmostOnDrag

public upperLabel: string source

Upper spot for writing a label on the bal.. Default value is "".

Private Methods

private draw() source

Main draw function for the ball called by the World automatically.

private isMouseOver(): boolean source

Tests if the mouse is over the ball.

Override:

WorldElement#isMouseOver

Return:

boolean

True if the mouse is over the ball, false otherwise.