visit -> behavior api

Author: nakednous

examples/basics/CajasOrientadas/CajasOrientadas.pde

@@ -39,7 +39,7 @@ void setup() {
     cajas[i] = new Node(caja(random(10, 40), random(10, 40), random(10, 40)));
     cajas[i].togglePicking(Node.SHAPE | Node.AXES);
     cajas[i].enableHint(Node.AXES | Node.BULLSEYE);
-    scene.setVisit(cajas[i], (Node node) -> {
+    scene.addBehavior(cajas[i], (Node node) -> {
       Vector to = Vector.subtract(esfera.position(), node.position());
       node.setOrientation(Quaternion.from(Vector.plusJ, to));
     });

examples/basics/SceneBuffers/SceneBuffers.pde

@@ -1,6 +1,6 @@
 /**
  * Scene Buffers.
- * by Jean Pierre Charalambos.
+ * by Sebastian Chaparro & Jean Pierre Charalambos.
  *
  * This example displays the scene front and back buffers.
  *

examples/demos/FlockOfBoids/Boid.pde

@@ -13,7 +13,7 @@ class Boid {
 
   Boid(Vector inPos) {
     node = new Node(this::display);
-    node.setVisit(scene, this::behavior);
+    startAnimation();
     position = new Vector();
     position.set(inPos);
     node.setPosition(new Vector(position.x(), position.y(), position.z()));
@@ -22,7 +22,15 @@ class Boid {
     neighborhoodRadius = 100;
   }
 
-  public void display(PGraphics pg) {
+  void startAnimation() {
+    node.setBehavior(scene, this::behavior);
+  }
+
+  void stopAnimation() {
+    scene.resetBehavior(node);
+  }
+
+  void display(PGraphics pg) {
     pg.pushStyle();
     // uncomment to draw boid axes
     //Scene.drawAxes(pg, 10);
@@ -152,4 +160,4 @@ class Boid {
     if (position.z() < 0)
       position.setZ(flockDepth);
   }
-}
+}

examples/demos/FlockOfBoids/FlockOfBoids.pde

@@ -36,6 +36,7 @@ int flockWidth = 1280;
 int flockHeight = 720;
 int flockDepth = 600;
 boolean avoidWalls = true;
+boolean animate = true;
 
 int initBoidNum = 400; // amount of boids to start the program with
 ArrayList<Boid> flock;
@@ -150,8 +151,15 @@ void mouseWheel(MouseEvent event) {
 void keyPressed() {
   switch (key) {
   case 'a':
-    //for (Boid boid : flock)
-      //boid.task.toggle();
+    animate = !animate;
+    for (Boid boid : flock) {
+      if (animate) {
+        boid.startAnimation();
+      }
+      else {
+        boid.stopAnimation();
+      }
+    }
     break;
   case 's':
     if (scene.eye().reference() == null)

examples/demos/PostEffects/PostEffects.pde

@@ -1,6 +1,6 @@
 /**
  * Post Effects.
- * by Ivan Castellanos and Jean Pierre Charalambos.
+ * by Ivan Castellanos & Jean Pierre Charalambos.
  *
  * This example is an adaption of Neil Mendoza great openFrameworks
  * ofxPostProcessing addon (http://www.neilmendoza.com/ofxpostprocessing/)

examples/demos/ViewFrustumCulling/ViewFrustumCulling.pde

@@ -5,10 +5,10 @@
  * This example illustrates a basic view frustum culling implementation which
  * is performed by analytically solving the frustum plane equations.
  *
- * A customized traversal rendering algorithm is implemented by overriding the
- * node visit() method to clip an octree against the camera's viewing frustum.
- * A second viewer displays an external view of the main frustum scene (using
- * the main scene eye BOUNDS hint) and the clipped octree.
+ * A customized traversal rendering algorithm is implemented by adding a custom
+ * node behavior for the main scene to clip an octree against the camera's viewing
+ * frustum. A second viewer displays an external view of the main frustum scene
+ * (using the main scene eye BOUNDS hint) and the clipped octree.
  *
  * Press the space-bar to change the scene type: PERSPECTIVE or ORTHOGRAPHIC.
  */
@@ -67,7 +67,7 @@ Node node(Node parent, Vector vector) {
     pg.box(a, b, c);
   });
   // register the culling method only at the main scene
-  mainScene.setVisit(node, this::cull);
+  mainScene.addBehavior(node, this::cull);
   return node;
 }
 

src/nub/core/Graph.java

@@ -129,7 +129,7 @@ public class Graph {
   protected static HashSet<Node> _interpolators = new HashSet<Node>();
 
   // Custom render
-  protected HashMap<Integer, BiConsumer<Graph, Node>> _functors;
+  protected HashMap<Integer, BiConsumer<Graph, Node>> _behaviors;
 
   // offscreen
   protected int _upperLeftCornerX, _upperLeftCornerY;
@@ -385,7 +385,7 @@ protected void _init(Object context, int width, int height, Node eye, Type type)
     _irays = _i1rays;
     // dummy
     _orays = _i2rays;
-    _functors = new HashMap<Integer, BiConsumer<Graph, Node>>();
+    _behaviors = new HashMap<Integer, BiConsumer<Graph, Node>>();
     if (eye == null) {
       throw new RuntimeException("Error eye shouldn't be null");
     }
@@ -1634,7 +1634,6 @@ public void fit(Node node) {
    * @see #fitFOV()
    * @see #fitFOV(float)
    */
-  //TODO needs testing with flock
   public void fit(Node node, float duration) {
     if (duration <= 0) {
       _eye.set(node);
@@ -2518,11 +2517,11 @@ public void closeContext() {
 
   /**
    * Renders the node tree onto the {@link #context()} from the {@link #eye()} viewpoint.
-   * Calls {@link #setVisit(Node, BiConsumer)} on each visited node (refer to the {@link Node} documentation).
+   * Calls {@link #addBehavior(Node, BiConsumer)} on each visited node (refer to the {@link Node} documentation).
    * Same as {@code render(null)}.
    *
    * @see #render(Node)
-   * @see #setVisit(Node, BiConsumer)
+   * @see #addBehavior(Node, BiConsumer)
    * @see Node#cull
    * @see Node#bypass()
    * @see Node#setShape(Consumer)
@@ -2541,10 +2540,11 @@ public void render() {
    * within {@link #openContext()} and {@link #closeContext()}.
    *
    * <p>
-   * Note that the rendering algorithm calls {@link #setVisit(Node, BiConsumer)} on each visited node
+   * Note that the rendering algorithm executes the custom behavior (set with
+   * {@link #addBehavior(Node, BiConsumer)}) on each rendered node.
    * (refer to the {@link Node} documentation).
    *
-   * @see #setVisit(Node, BiConsumer)
+   * @see #addBehavior(Node, BiConsumer)
    * @see Node#cull
    * @see Node#bypass()
    * @see Node#setShape(Consumer)
@@ -2575,7 +2575,8 @@ public void render(Node subtree) {
   }
 
   /**
-   * Sets a custom node visit for the {@link #render()} algorithm.
+   * Adds a custom node behavior to be executed for this scene
+   * {@link #render()} algorithm.
    * <p>
    * Bypassing the node rendering and/or performing hierarchical culling, i.e.,
    * culling of the node and its children, should be done here.
@@ -2584,57 +2585,57 @@ public void render(Node subtree) {
    * {@code
    * Graph scene = new Graph(context, width, height);
    * Node space = new Node();
-   * public void visit(Graph graph, Node node) {
+   * public void behavior(Graph graph, Node node) {
    *   if (graph.cullingCondition) {
    *     node.cull = true;
    *   }
    *   else if (bypassCondition) {
    *     node.bypass();
    *   }
    * }
-   * scene.setVisit(space, visit);
+   * scene.addBehavior(space, behavior);
    * }
    * </pre>
    * Note that the graph culling condition may be set from
    * {@link #ballVisibility(Vector, float)} or {@link #boxVisibility(Vector, Vector)}.
    *
-   * @see #setVisit(Node, Consumer)
-   * @see #resetVisit(Node)
+   * @see #addBehavior(Node, Consumer)
+   * @see #resetBehavior(Node)
    * @see #render(Node)
-   * @see Node#setVisit(Graph, BiConsumer)
-   * @see Node#setVisit(Graph, Consumer)
+   * @see Node#setBehavior(Graph, BiConsumer)
+   * @see Node#setBehavior(Graph, Consumer)
    * @see Node#bypass()
    * @see Node#cull
    */
-  public void setVisit(Node node, BiConsumer<Graph, Node> functor) {
-    _functors.put(node.id(), functor);
+  public void addBehavior(Node node, BiConsumer<Graph, Node> behavior) {
+    _behaviors.put(node.id(), behavior);
   }
 
   /**
-   * Same as {@code setVisit(node, (g, n) -> functor.accept(n))}.
+   * Same as {@code setBehavior(node, (g, n) -> behavior.accept(n))}.
    *
-   * @see #setVisit(Node, BiConsumer)
-   * @see #resetVisit(Node)
+   * @see #addBehavior(Node, BiConsumer)
+   * @see #resetBehavior(Node)
    * @see #render(Node)
-   * @see Node#setVisit(Graph, BiConsumer)
-   * @see Node#setVisit(Graph, Consumer)
+   * @see Node#setBehavior(Graph, BiConsumer)
+   * @see Node#setBehavior(Graph, Consumer)
    * @see Node#bypass()
    * @see Node#cull
    */
-  public void setVisit(Node node, Consumer<Node> functor) {
-    setVisit(node, (g, n) -> functor.accept(n));
+  public void addBehavior(Node node, Consumer<Node> behavior) {
+    addBehavior(node, (g, n) -> behavior.accept(n));
   }
 
   /**
-   * Resets the node custom visit set with {@link #setVisit(Node, BiConsumer)}.
+   * Resets the node custom behavior which is set with {@link #addBehavior(Node, BiConsumer)}.
    *
-   * @see #setVisit(Node, BiConsumer)
+   * @see #addBehavior(Node, BiConsumer)
    * @see #render(Node)
    * @see Node#bypass()
    * @see Node#cull
    */
-  public void resetVisit(Node node) {
-    _functors.remove(node.id());
+  public void resetBehavior(Node node) {
+    _behaviors.remove(node.id());
   }
 
   /**
@@ -2644,10 +2645,16 @@ protected void _render(Node node) {
     _matrixHandler.pushMatrix();
     node._execute(this);
     _matrixHandler.applyTransformation(node);
-    // TODO should go before pushMatrix ???
-    BiConsumer<Graph, Node> functor = _functors.get(node.id());
-    if (functor != null) {
-      functor.accept(this, node);
+    // TODO ordering of operations is a bit experimental.
+    // For instance should the visits go before pushMatrix?
+    // I believe it belongs here, i.e., current node culling
+    // condition may require local geometry operations.
+    // On the oder hand, timing stuff (node_execute) may only
+    // be executed once it's known for sure the node is not
+    // culled :-/
+    BiConsumer<Graph, Node> behavior = _behaviors.get(node.id());
+    if (behavior != null) {
+      behavior.accept(this, node);
     }
     if (!node.cull) {
       if (node._bypass != _frameCount) {

src/nub/core/Interpolator.java

@@ -104,7 +104,7 @@ protected Vector _translation() {
       return _node.reference() == _keyFrame.reference() ? _keyFrame.position() :
           _node.reference() == null ? _keyFrame.worldPosition() : _node.reference().location(_keyFrame.worldPosition());
       // perhaps less efficient but simpler equivalent form:
-      // return _node.reference() == null ? _keyFrame.position() : _node.reference().location(_keyFrame.position());
+      // return _node.reference() == null ? _keyFrame.worldPosition() : _node.reference().location(_keyFrame.worldPosition());
     }
 
     /**
@@ -115,7 +115,7 @@ protected Quaternion _rotation() {
       return _node.reference() == _keyFrame.reference() ? _keyFrame.orientation() :
           _node.reference() == null ? _keyFrame.worldOrientation() : _node.reference().displacement(_keyFrame.worldOrientation());
       // perhaps less efficient but simpler equivalent form:
-      // return _node.reference() == null ? _keyFrame.orientation() : _node.reference().displacement(_keyFrame.orientation());
+      // return _node.reference() == null ? _keyFrame.worldOrientation() : _node.reference().displacement(_keyFrame.worldOrientation());
     }
 
     /**
@@ -126,7 +126,7 @@ protected float _scaling() {
       return _node.reference() == _keyFrame.reference() ? _keyFrame.magnitude() :
           _node.reference() == null ? _keyFrame.worldMagnitude() : _node.reference().displacement(_keyFrame.worldMagnitude());
       // perhaps less efficient but simpler equivalent form:
-      // return _node.reference() == null ? _keyFrame.magnitude() : _node.reference().displacement(_keyFrame.magnitude());
+      // return _node.reference() == null ? _keyFrame.worldMagnitude() : _node.reference().displacement(_keyFrame.worldMagnitude());
     }
   }