Difference between revisions of "Adding object to scene"

From XStoryPlayer Wiki
Jump to: navigation, search
 
(15 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
==Steps==
 
==Steps==
 
<ol>
 
<ol>
<li>Copy the bench files from the 'Tutorial resource pack' to the sources directory. It is a simple bench that will be placed in the cell.</li>
+
<li>Copy the bench1 files from the 'Tutorial resource pack' to the sources directory. It is a simple bench that will be placed in the cell.</li>
<li>The most simple way to add an object to a scene is to use the reference editor in Maya. Do [File->Create Reference] in Maya and add the <code>bench.ma</code> to the <code>scene.ma</code>. Run the [[Filemaker]] and create the scene again. Run the scene, you should see the bench in the scene.</li>
+
<li>The most simple way to add an object to a scene is to use the reference editor in Maya. Do [File->Create Reference] in Maya and add the <code>bench.ma</code> to the <code>scene.ma</code>.</li>
 +
<li>Add the <code>bench.ma</code> to the <code>start.ini</code> of the [[Filemaker]]. Run the [[Filemaker]] and create the scene again. Run the scene, you should see the bench in the scene.</li>
 
<li>Remove the bench from the scene again using [File->Reference Editor]. Now we will add the object dynamically to the scene.<br>
 
<li>Remove the bench from the scene again using [File->Reference Editor]. Now we will add the object dynamically to the scene.<br>
 
Add this code to the <code>/init/story/scenes.dat</code> at the bottom off this file.<br>
 
Add this code to the <code>/init/story/scenes.dat</code> at the bottom off this file.<br>
Line 10: Line 11:
 
dyn_objecti BENCH1
 
dyn_objecti BENCH1
 
{
 
{
   scene_id = SPACESHIP1;
+
   scene_id = SPACESHIP1; // The scene
 +
 
 +
  pos = (0,0,-1); // Position
 +
  rot = (0,0,0);  // Rotation
 
    
 
    
   file_name = "scenes/object/benchShape.obj";
+
   file_name = "scenes/object/benchShape.obj"; // The object file
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
This will create the bench dynamically in the scene.
+
This will create the bench dynamically in the scene. Run the story and you should now also see the bench in the scene.
 
</li>
 
</li>
 
<li>The <code>bench.ini</code> file describes the bench object.<br>
 
<li>The <code>bench.ini</code> file describes the bench object.<br>
Line 56: Line 60:
 
   }
 
   }
 
}
 
}
<syntaxhighlight>
+
</syntaxhighlight>
 
Run the filemaker and test the scene, run into the bench and it should move.
 
Run the filemaker and test the scene, run into the bench and it should move.
 
</li>
 
</li>
<li>Now lets make a soft body object of the bench.</li>
+
<li>Now lets make a soft body object of the bench. Copy the bench2 files from the 'Tutorial resource pack' to the sources directory (replace the existing bench files).<br>
 +
It is the same bench but with higher sub-division for both the mesh and the collider. Change the <code>bench.ini</code> to this:
 +
<syntaxhighlight lang="cpp">
 +
soft "benchShape"
 +
{
 +
  dynamic
 +
  {
 +
    grid_x = 4; // Divide x-axis in 4 soft clusters
 +
    grid_y = 2; // Divide y-axis in 2 soft clusters
 +
    grid_z = 2; // Divide y-axis in 2 soft clusters
 +
 
 +
    s = 100.0; // Spring strength (increase to make harder)
 +
    d = 1.0;  // Spring damping
 +
  }
 +
 
 +
  render {}
 +
 
 +
  physics
 +
  {
 +
    density = 50.0; // Make light so we can pick it up
 +
 
 +
    mesh = "coll1Shape"; // The collision mesh
 +
  }
 +
}
 +
</syntaxhighlight>
 +
Run the filemaker and test the scene. The bench should be soft now.<br>
 +
[[file:soft_obj1.jpg|600px]]</li>
 +
<li>
 +
Now lets have some fun with the object. Create a large pile of benches stacked by adding this code to the <code>scenes.dat</code> file:<br>
 +
<syntaxhighlight lang="cpp">
 +
dyn_object BENCH
 +
{
 +
  scene_id = SPACESHIP1;
 +
 
 +
  file_name = "scenes/object/benchShape.obj";
 +
 
 +
  rot = (0,0,0);
 +
}
 +
 
 +
dyn_objecti:BENCH BENCH1 {pos = (6.5,0,-2);}
 +
dyn_objecti:BENCH BENCH2 {pos = (6.5,0.56,-2);}
 +
dyn_objecti:BENCH BENCH3 {pos = (6.5,1.12,-2);}
 +
dyn_objecti:BENCH BENCH4 {pos = (6.5,1.68,-2);}
 +
dyn_objecti:BENCH BENCH5 {pos = (6.5,2.24,-2);}
 +
dyn_objecti:BENCH BENCH6 {pos = (6.5,2.8,-2);}
 +
dyn_objecti:BENCH BENCH7 {pos = (6.5,3.36,-2);}
 +
dyn_objecti:BENCH BENCH8 {pos = (6.5,3.92,-2);}
 +
dyn_objecti:BENCH BENCH9 {pos = (6.5,4.48,-2);}
 +
dyn_objecti:BENCH BENCH10 {pos = (6.5,5.04,-2);}
 +
</syntaxhighlight>
 +
[[file:soft_obj2.jpg|600px]]<br>
 +
Remove the play-code afterwards. So we can proceed with adding some more conversation to our story, in the next tutorial '[[Adding words to the NLP]]'.</li>
 
</ol>
 
</ol>

Latest revision as of 16:27, 16 January 2015

In this tutorial we will explore different ways to add an object to a scene.

Steps

  1. Copy the bench1 files from the 'Tutorial resource pack' to the sources directory. It is a simple bench that will be placed in the cell.
  2. The most simple way to add an object to a scene is to use the reference editor in Maya. Do [File->Create Reference] in Maya and add the bench.ma to the scene.ma.
  3. Add the bench.ma to the start.ini of the Filemaker. Run the Filemaker and create the scene again. Run the scene, you should see the bench in the scene.
  4. Remove the bench from the scene again using [File->Reference Editor]. Now we will add the object dynamically to the scene.
    Add this code to the /init/story/scenes.dat at the bottom off this file.
    dyn_objecti BENCH1
    {
      scene_id = SPACESHIP1; // The scene
     
      pos = (0,0,-1); // Position
      rot = (0,0,0);  // Rotation
     
      file_name = "scenes/object/benchShape.obj"; // The object file
    }

    This will create the bench dynamically in the scene. Run the story and you should now also see the bench in the scene.

  5. The bench.ini file describes the bench object.
    rb "benchShape" // A rigidbody object
    {
      // Only render the object.
      // In essence it is now the same as a rd (render) object.
      render {}
    }

    We want to add a collider to the object. Place a cube named coll1Shape around the bench and change the code of the bench.ini to this:

    rb "benchShape"
    {
      render {}
      physics
      {
        elem[0] {mesh = "coll1Shape";}
      }
    }

    Run the filemaker and test the scene, you should collide now with the bench.

  6. Now lets make the object dynamic. Change the bench.ini to this:
    rb "benchShape"
    {
      dynamic = true; // Object is dynamic
     
      render {}
     
      physics
      {
        density = 200; // 200 kg per cubic meter
        fc      = 0.1; // Low friction
     
        elem[0] {mesh = "coll1Shape";}
      }
    }

    Run the filemaker and test the scene, run into the bench and it should move.

  7. Now lets make a soft body object of the bench. Copy the bench2 files from the 'Tutorial resource pack' to the sources directory (replace the existing bench files).
    It is the same bench but with higher sub-division for both the mesh and the collider. Change the bench.ini to this:
    soft "benchShape"
    {
      dynamic
      {
        grid_x = 4; // Divide x-axis in 4 soft clusters
        grid_y = 2; // Divide y-axis in 2 soft clusters
        grid_z = 2; // Divide y-axis in 2 soft clusters
     
        s = 100.0; // Spring strength (increase to make harder)
        d = 1.0;   // Spring damping
      }
     
      render {}
     
      physics
      {
        density = 50.0; // Make light so we can pick it up
     
        mesh = "coll1Shape"; // The collision mesh
      }
    }

    Run the filemaker and test the scene. The bench should be soft now.

    Soft obj1.jpg
  8. Now lets have some fun with the object. Create a large pile of benches stacked by adding this code to the scenes.dat file:
    dyn_object BENCH
    {
      scene_id = SPACESHIP1;
     
      file_name = "scenes/object/benchShape.obj";
     
      rot = (0,0,0);
    }
     
    dyn_objecti:BENCH BENCH1 {pos = (6.5,0,-2);}
    dyn_objecti:BENCH BENCH2 {pos = (6.5,0.56,-2);}
    dyn_objecti:BENCH BENCH3 {pos = (6.5,1.12,-2);}
    dyn_objecti:BENCH BENCH4 {pos = (6.5,1.68,-2);}
    dyn_objecti:BENCH BENCH5 {pos = (6.5,2.24,-2);}
    dyn_objecti:BENCH BENCH6 {pos = (6.5,2.8,-2);}
    dyn_objecti:BENCH BENCH7 {pos = (6.5,3.36,-2);}
    dyn_objecti:BENCH BENCH8 {pos = (6.5,3.92,-2);}
    dyn_objecti:BENCH BENCH9 {pos = (6.5,4.48,-2);}
    dyn_objecti:BENCH BENCH10 {pos = (6.5,5.04,-2);}

    Soft obj2.jpg

    Remove the play-code afterwards. So we can proceed with adding some more conversation to our story, in the next tutorial 'Adding words to the NLP'.