NewComponent
Summary
This component is responsible for creating new plans.
Constructor
NewComponent
Syntax
NewComponent
(
-
core
Summary
Parameters:
-
coreCoreThe main engine.
Item Index
Methods
Methods
createNewPlan
Syntax
createNewPlan
()
Summary
Creates a new plan.
destroy
Syntax
destroy
()
Summary
Called when the component is destroyed. The menu item is removed.
disable
Syntax
disable
()
Summary
Disables the componentenable
Syntax
enable
()
Summary
Enables the componentgetTargeted
Syntax
Summary
Finds out if the given position is over an element handled by the componentParameters:
-
vectorVectorA position, usually the cursor's one.
Returns:
Object:
The targeted element, or null if nothing is found.
initialize
Syntax
initialize
()
Summary
Initializes the component by adding a new entry in the top menu.
launchProcess
Syntax
launchProcess
()
Summary
Launches the creation of a new plan. It destroys the previous one, but saves the history.
Triggered on event wnp.request.newPlan
onContextChanged
Syntax
onContextChanged
(
-
context
Summary
Method called when the context is switched (2D -> 3D or 3D -> 2D)Parameters:
-
contextStringThe new context
startListening
Syntax
startListening
()
Summary
Calls all the event listeners.stopListening
Syntax
stopListening
()
Summary
Removes all the event listeners.update
Syntax
update
()
Summary
Generic update method, called on every frameProperties
priority
Syntax
priority
Number
Summary
Priority of the component in the "update" and "draw" routinesstructure
Syntax
structure
wnp.Structure
Summary
Structure file instance (shortcut to wanaplan.structure). This is the base object where the whole plan is savedEvents
wnp.request.closePopup
Syntax
wnp.request.closePopup
Summary
Fired to close a popup.
wnp.request.newPlan
Syntax
wnp.request.newPlan
Summary
Fired when a new plan needs to be created.
wnp.request.newPlanReady
Syntax
wnp.request.newPlanReady
Summary
Fired when a new plan is ready.
wnp.request.saveStructure
Syntax
wnp.request.saveStructure
Summary
Fired to request the save of a structure.