import Constant from 'canvas-template/src/js/molecules/constant.js'

public class | source

Constant

Extends:

Atom → Constant

This class creates the constant atom instance which can be used to define a numerical constant.

Constructor Summary

Public Constructor
public	constructor(values: object) Creates a new constant atom.

Member Summary

Public Members
public	atomType: string This atom's type
public	description: string A description of this atom
public	evolve: boolean A flag to indicate if this constant should be evolved by genetic algorithms
public	height: number This atom's height as drawn on the screen
public	max: float Maximum value to be used when evolving constant
public	min: float Minimum value to be used when evolving constant
public	name: string This atom's name
public	type: string This atom's type
public	value: float The default value for the constant

Method Summary

Public Methods
public	beginPropagation() Starts propagation from this atom if it is not waiting for anything up stream.
public	draw() Draw the Bill of material atom which has a BOM icon.
public	loadTree(): * Sets all the input and output values to match their associated atoms.
public	sendToRender() Send the value of this atom to the 3D display.
public	serialize(values: ): Add the value to be saved to the object saved for this molecule.
public	updateSidebar() Add entries for name and value to the side bar.
public	updateValue() Set's the output value and shows the atom output on the 3D view.
public	walkBackForConstants(callback: *) Used to walk back out the tree generating a list of constants...used for evolving

Inherited Summary

From class Atom
public	[key]: * Assign each of the values in values as this.value
public	alertMessage: string A warning message displayed next to the atom.
public	cancelProcessing: function A function which can be called to cancel the processing being done for this atom.
public	color: string This atom's current color
public	defaultColor: string This atom's default color (ie when not selected or processing)
public	description: string A description of this atom
public	inputs: array An array of all of the input attachment points connected to this atom
public	isMoving: boolean A flag to indicate if this atom is currently being dragged on the screen.
public	name: string This atom's name
public	output: object This atom's output attachment point if it has one
public	parentMolecule: object This atom's parent, usually the molecule which contains this atom
public	path: string The path which contains the geometry represented by this atom
public	processing: boolean A flag to indicate if the atom is currently computing a new output.
public	radius: number This atom's radius as displayed on the screen is 1/72 width
public	selected: boolean A flag to indicate if this atom is currently selected
public	selectedColor: string This atom's color when selected
public	showHover: boolean A flag to indicate if we are hovering over this atom.
public	strokeColor: string The color currently used for strokes
public	uniqueID: number This atom's unique ID. Often overwritten later when loading
public	value: object This atom's value...Is can this be done away with? Are we basically storing the value in the output now?
public	x: number The X cordinate of this atom
public	y: number The Y cordinate of this atom
public	addIO(type: boolean, name: string, target: object, valueType: string, defaultValue: object) Adds a new attachment point to this atom
public	basicThreadValueProcessing(toAsk: *) Calls a worker thread to compute the atom's value.
public	beginPropagation() Starts propagation placeholder.
public	census(): number[] Returns an array of length two indicating that this is one atom and if it is waiting to be computed
public	clearAlert() Clears the alert message attached to this atom.
public	clickDown(x: number, y: number, clickProcessed: boolean): * Set the atom's response to a mouse click. This usually means selecting the atom and displaying it's contents in 3D
public	clickMove(x: number, y: number) Set the atom's response to a mouse click and drag. Moves the atom around the screen.
public	clickUp(x: number, y: number) Set the atom's response to a mouse click up. If the atom is moving this makes it stop moving.
public	createButton(list: object, parent: object, buttonText: string, functionToCall: object) Creates button.
public	createCheckbox(list: object, buttonText: string, -: boolean, functionToCall: object) Creates button.
public	createDropDown(list: object, parent: object, options: array, selectedOption: number, description: string, Callback: object) Creates dropdown with multiple options to select.
public	createEditableValueListItem(list: object, object: object, key: string, label: string, resultShouldBeNumber: boolean, callBack: object) Creates an editable HTML item to set the value of an object element.
public	createFileUpload(list: object, parent: object, buttonText: string, functionToCall: object) Creates file upload button.
public	createMarkdownListItem(list: object, texxt: string) Creates a html representation of the passed text.
public	createNonEditableValueListItem(list: object, object: object, key: string, label: string) Creates an non-editable HTML item to set the value of an object element.
public	decreaseToProcessCountByOne() Set's the output value and shows the atom output on the 3D view.
public	deleteNode(backgroundClickAfter: boolean, deletePath: boolean, silent: boolean) Delete this atom.
public	displayAndPropagate() Displays the atom in 3D and sets the output.
public	doubleClick(x: number, y: number): * Set the atom's response to a mouse double click. By default this isn't to do anything other than mark the double click as handled.
public	draw(drawType: *) Draws the atom on the screen
public	findIOValue(ioName: string): * Find the value of an input for with a given name.
public	generatePath() Generates the path for this atom from it's location in the graph
public	initializeSideBar(): * Initialized the sidebar with a title and create the HTML object.
public	keyPress(key: string) Set the atom's response to a key press. Is used to delete the atom if it is selected.
public	loadTree(): * Sets all the input and output values to match their associated atoms.
public	removeIO(type: boolean, name: string, target: object, silent: object) Removes an attachment point from an atom.
public	requestReadme(): *[] Return any contribution from this atom to the README file
public	selectBox(x: , y: , xEnd: , yEnd: ) Delineates bounds for selection box.
public	sendToRender() Send the value of this atom to the 3D display.
public	serialize(offset: {"x": number, "y": number}): * Create an object containing the information about this atom that we want to save.
public	setAlert(message: string) Set an alert to display next to the atom.
public	setValues(values: object) Applies each of the passed values to this as this.x
public	update() Runs with each frame to draw the atom.
public	updateSidebar(): * Updates the side bar to display information about the atom.
public	updateValue() Token update value function to give each atom one by default
public	waitOnComingInformation() Sets the atom to wait on coming information.
public	walkBackForConstants(callback: *) Used to walk back out the tree generating a list of constants...used for evolve

Public Constructors

public constructor(values: object) source

Creates a new constant atom.

Override:

Atom#constructor

Params:

Name	Type	Attribute	Description
values	object		An object of values. Each of these values will be applied to the resulting atom.

Public Members

public atomType: string source

This atom's type

public description: string source

A description of this atom

Override:

Atom#description

public evolve: boolean source

A flag to indicate if this constant should be evolved by genetic algorithms

public height: number source

This atom's height as drawn on the screen

public max: float source

Maximum value to be used when evolving constant

public min: float source

Minimum value to be used when evolving constant

public name: string source

This atom's name

Override:

Atom#name

public type: string source

This atom's type

public value: float source

The default value for the constant

Override:

Atom#value

Public Methods

public beginPropagation() source

Starts propagation from this atom if it is not waiting for anything up stream.

Override:

Atom#beginPropagation

public draw() source

Draw the Bill of material atom which has a BOM icon.

Override:

Atom#draw

public loadTree(): * source

Sets all the input and output values to match their associated atoms.

Override:

Atom#loadTree

Return:

public sendToRender() source

Send the value of this atom to the 3D display. Used to display the number

Override:

Atom#sendToRender

public serialize(values: ): source

Add the value to be saved to the object saved for this molecule.

Override:

Atom#serialize

Params:

Name	Type	Attribute	Description
values	*

Return:

public updateSidebar() source

Add entries for name and value to the side bar. Note: I think that should happen automatically and this function can be deleted. Please test that future self.

Override:

Atom#updateSidebar

public updateValue() source

Set's the output value and shows the atom output on the 3D view.

Override:

Atom#updateValue

public walkBackForConstants(callback: *) source

Used to walk back out the tree generating a list of constants...used for evolving

Override:

Atom#walkBackForConstants

Params:

Name	Type	Attribute	Description
callback	*

Constant

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(values: object) source

Override:

Params:

Public Members

public atomType: string source

public description: string source

Override:

public evolve: boolean source

public height: number source

public max: float source

public min: float source

public name: string source

Override:

public type: string source

public value: float source

Override:

Public Methods

public beginPropagation() source

Override:

public draw() source

Override:

public loadTree(): * source

Override:

Return:

public sendToRender() source

Override:

public serialize(values: *): * source

Override:

Params:

Return:

public updateSidebar() source

Override:

public updateValue() source

Override:

public walkBackForConstants(callback: *) source

Override:

Params:

public serialize(values: ): source