Wiring - Revision history

Gmeader at 01:01, 10 November 2022

2022-11-10T01:01:21Z

Gmeader: added Background info on wiring

2022-10-28T17:29:04Z

added Background info on wiring

Gmeader: /* Parameters */

2022-03-28T22:24:04Z

Parameters

Gmeader: /* Inputs */

2022-03-28T22:22:23Z

Inputs

Gmeader: /* Inputs */

2022-03-28T22:18:27Z

Inputs

Gmeader: /* Outputs */

2022-03-28T22:17:16Z

Outputs

Gmeader: /* Outputs */

2022-03-28T22:16:29Z

Outputs

Gmeader: /* Outputs */

2022-03-28T22:15:27Z

Outputs

Gmeader: /* Inputs */

2022-03-28T22:12:52Z

Inputs

Gmeader: /* Outputs */

2022-03-28T22:03:17Z

Outputs

@@ Line 125: / Line 125: @@
 # You are done. Choose PLAY on the wrist menu and the cube should change its rotation every second.
 ==Controllers==
 Controllers are objects that make controlling objects with wiring easier. You connect the output of a controller to the input of an object. For example, a controller outputs a position, that is wired to the input setPosition of an object you want to move. All Controllers have a '''ControlOut''' Output that is commonly wired to another object's '''ControlIn''' Input. This sends the information the controller is generating to the target object in a way that the object will know what to do, without you having to to know what exact ''setWhatever'' input to choose. See [[Moving_Objects_Along_Paths]] for more details on Controllers.

@@ Line 163: / Line 163: @@
 </pre>
 </code>
 Next: '''[[Moving_Objects_Along_Paths]]'''

@@ Line 116: / Line 116: @@
 You have to get the value(s) for the required parameters from another object - typically that's a '''Variable''' type of object.
-Create a Non-Spatial EulerRandom object. That is an object that creates a random pitch, Yaw, Roll value that can be used to set an object's orientation (Rotation).
+# Create a Non-Spatial EulerRandom object. That is an object that creates a random pitch, Yaw, Roll value that can be used to set an object's orientation (Rotation).
+# Create a timer and a cube. We are going to make the cube rotate to a new oreintation every time the timer goes off (once per second)
-Create a timer and a cube. We are going to make the cube rotate to a new oreintation every time the timer goes off (once per second)
+# Click on the WIRE/CODE wrist menu. Click on the timer to make the wiring handle visible.
+# Click on the wiring handle ball and choose the Output tick item. Tick sends a message every time the timer triggers.
-Click on the WIRE/CODE wrist menu. Click on the timer to make the wiring handle visible.
+# Drag the wire to the cube and a wiring handle will appear. Choose the Input State setRotation item. Now the timer is wired to the Cube's setRotation method.
+# You will notice a red ball in the middle of the wire. That means you need to provide a parameter (a value that will be the new rotation).
-Click on the wiring handle ball and choose the Output tick item. Tick sends a message every time the timer triggers.
+# Click the red ball and choose the rotation item. Drag the wire to the EulerRandom object and choose the Input getValue. Now the EulerRandom object will provide a rotation parameter.
+# You are done. Choose PLAY on the wrist menu and the cube should change its rotation every second.
 ==Controllers==

@@ Line 89: / Line 89: @@
 ** getRotation
 ** '''setRotation''' - instantly rotates the object to the given rotation
-** '''rotateBy''' - gradually rotates the object by a given rotation vector Parameters: rotation and time
+** '''rotateBy''' - gradually rotates the object by a given rotation vector Parameters: (rotation, time)
 ** '''rotateTo''' - gradually rotates the object to a given rotation Parameters: rotation and time
-** rotateAround
+** rotateAround (vector3f,float,int)
-** '''rotateAroundYAxisB'''y - gradually rotates the object to an angle in a given time Parameters: position and time
+** '''rotateAroundYAxisBy''' - gradually rotates the object to an angle in a given time Parameters: (rotation, time)
-** setPositionAndRotation
+** '''setPositionAndRotation''' (position, rotation)
-** lookAt
+** '''lookAt'''(vector3f)
 * position
 ** getPosition

@@ Line 77: / Line 77: @@
 Commonly used outputs include:
 * control
-** controlIn - usually connected to the controlOut of a controller object.
+** '''controlIn''' - usually connected to the controlOut of a controller object.
 * visibility
-** toggle - hide or show the object, switching it from its current state
+** '''toggle''' - hide or show the object, switching it from its current state
-** off - hide the object
+** '''off''' - hide the object
-** on - make the object visible
+** '''on''' - make the object visible
 ** getVisibility
 * scale
@@ Line 88: / Line 88: @@
 * rotation
 ** getRotation
-** setRotation - instantly rotates the object to the given rotation
+** '''setRotation''' - instantly rotates the object to the given rotation
-** rotateBy - gradually rotates the object by a given rotation vector Parameters: rotation and time
+** '''rotateBy''' - gradually rotates the object by a given rotation vector Parameters: rotation and time
-** rotateTo - gradually rotates the object to a given rotation Parameters: rotation and time
+** '''rotateTo''' - gradually rotates the object to a given rotation Parameters: rotation and time
 ** rotateAround
-** rotateAroundYAxisBy - gradually rotates the object to an angle in a given time Parameters: position and time
+** '''rotateAroundYAxisB'''y - gradually rotates the object to an angle in a given time Parameters: position and time
 ** setPositionAndRotation
 ** lookAt
 * position
 ** getPosition
-** setPosition - instantly moves the object to the given position
+** '''setPosition''' - instantly moves the object to the given position
-** moveBy - gradually moves the position by a given vector Parameters: position and time
+** '''moveBy''' - gradually moves the position by a given vector Parameters: position and time
-** moveTo - gradually moves to a given position Parameters: position and time
+** '''moveTo''' - gradually moves to a given position Parameters: position and time
 ** moveToWaypoint
 ** moveForward

@@ Line 60: / Line 60: @@
 ** '''mouseDoubleClick''' - sent when the user double-clicks on the object
 ** '''mouseDown''' - sent when the user clicks on the object
-** '''mouseExite'''d - sent when the user's ray stops hovering over the object
+** '''mouseExited''' - sent when the user's ray stops hovering over the object
 ** '''mouseUp''' - sent when the user stops the click on the object
 * state
-** '''positionChanged''' - sent when the position changes
+** '''positionChanged''' - sent when the position of the object changes
 ** '''propertyChanged''' - sent when a property changes
 ** '''rotationChanged''' - sent when the rotation changes
-** '''scaleChanged''' - sent when the scale changes
+** '''scaleChanged''' - sent when the scale of the object changes
 * position
 ** movedBy

@@ Line 55: / Line 55: @@
 Commonly used outputs include:
 * Control
-** ControlOut - this is usually wired to the controlIn input on another object.
+** '''ControlOut''' - this is usually wired to the controlIn input on another object.
 * events
-** mouseEntered - sent when the user's ray hovers over the object
+** '''mouseEntered''' - sent when the user's ray hovers over the object
-** mouseDoubleClick - sent when the user double-clicks on the object
+** '''mouseDoubleClick''' - sent when the user double-clicks on the object
-** mouseDown - sent when the user clicks on the object
+** '''mouseDown''' - sent when the user clicks on the object
-** mouseExited - sent when the user's ray stops hovering over the object
+** '''mouseExite'''d - sent when the user's ray stops hovering over the object
-** mouseUp - sent when the user stops the click on the object
+** '''mouseUp''' - sent when the user stops the click on the object
 * state
-** positionChanged - sent when the position changes
+** '''positionChanged''' - sent when the position changes
-** propertyChanged - sent when a property changes
+** '''propertyChanged''' - sent when a property changes
-** rotationChanged - sent when the rotation changes
+** '''rotationChanged''' - sent when the rotation changes
-** scaleChanged - sent when the scale changes
+** '''scaleChanged''' - sent when the scale changes
 * position
 ** movedBy