OBJ Reader

From Terragen Documentation from Planetside Software
Jump to: navigation, search
OBJ Reader


Overview[edit]

The OBJ Reader node loads models from a Wavefront .OBJ file. The OBJ Reader can also load .mtl files specified by the OBJ containing texturing information. When you create an OBJ Reader it opens a file dialog allowing you to choose the file to load.


Node Type: Object


Settings:

  • Population mode: This popup has two options:
    Population mode parameters
    • Individual Object: This is the default for objects created individually, not part of a population. If you choose this option for objects that are part of a population the population instances will still render but the object itself will also show up at its original position.
    • Member of a Population: This is the default for objects created as part of creating a population. It means the objects only render as part of a population. If you choose this option for an individual object it won't render.

    If you create an object as part of a population and then decide to use it on its own you may need to change the popup to Individual Object to get it to render.

  • Preview mode: This popup has five options:
    Preview Mode parameters
    • This parameter lets you choose how the object should be displayed in the 3D Preview, and sets the most detailed mode that the object can be displayed in. The Object Display Mode button in the 3D Preview controls the mode for the preview as a whole. For example if you set the Preview mode of the object to Wireframe but the 3D Preview object display mode is set to Show as bounding boxes then the object will only be drawn as a bounding box.
  • Preview Colour: Enabling this parameter causes the object to be drawn in the 3D preview using the preview colour when the object display mode is set to bounding box or wireframe. When set to smooth shaded or texture display mode, the preview colour tints the object’s textured surface. This is useful for making a particular object stand out in the 3D preview. Clicking on the colour swatch to the right of the parameter label opens the Colour picker pane.

  • File Read Tab[edit]

    File Read Tab

    Settings:

    • Filename: This parameter shows the path to the file used by the OBJ Reader. You can use the file button at right to load a different file but this isn't recommended as the materials for the new file won't be loaded.


    Sequence Tab[edit]

    Sequence Tab

    Settings:

    • Sequence first: This value controls both the geometry and the frame on which that geometry is loaded.
      • For example, when set to a value of 1, MyObject_0001.obj will load on frame 1, when the “Offset” value is zero. If an “Offset” value other than zero is present, that value will be added to the “Sequence first” value to determine which geometry is loaded. For example, with an “Offset” value of “4”, MyObject_0005.obj will load on frame 1.
      • Ten sequential objects, looping, no offset.
        Ten sequential objects, looping, offset is four.


      • Terragen can cycle through a subset of the total available sequential geometry by specifying the range to use in the “Sequence first” and “Sequence last” values. For example, if the “Sequence first” value was set to “4” and the “Sequence last” value was set to “8”, then Terragen would cycle through the sequential objects named MyObject_0004.obj through MyObject_0008.obj. MyObject_0004.obj would load on frame 4 and MyObject_0008.obj would load on frame 8, if the “Offset” value were zero. Note, that frames 1, 2 and 3 would load MyObject_0006.obj, MyObject_0007.obj, and MyObject_0008.obj respectively if “Loop” where enabled, and MyObject_0005.obj, MyObject_0006.obj and MyObject_0007.obj if “Ping pong” were enabled.
      • Five sequential objects, looping, no offset.
        Five sequential objects, ping pong, no offset.


      • If the sequential object number does not exist, Terragen will display a warning message to alert you.
      • Warning message if sequential object is missing.


    • Sequence last: This value controls both the geometry and the frame on which that geometry is loaded.
      • For example, when set to a value of "10" and using an object sequence numbered 1 through 10, MyObject_0010.obj will load on frame 10 when the “Offset” value is set to "0".
      • If an “Offset” value other than "0" is present, that value will be added to the “Sequence last” value to determine which geometry is loaded, factoring in the number of available objects in the sequence and cycling through them based on the "Loop" or "Ping Pong" mode selected. For example, with an “Offset” value of “1” in a object sequence numbered 1 through 10, MyObject_0001.obj will load on frame 10 if “Loop” is enabled, or MyObject_0009.obj will load on frame 10 if “Ping Pong” is enabled.


    • Loop or Ping Pong: Upon completion of the sequential object cycle determined by the “Sequence first” value and “Sequence last” value, Terragen can either “loop” back to the “Sequence first” object and cycle through the objects as each frame advances, or it can “ping pong”, that is, reverse the object sequence order until the “Sequence first” object is encountered.
    • Ten sequential objects, looping, no offset.
      Ten sequential objects, Ping Pong, no offset


    • Frame offset: This value provides a way to load a different sequential object. Its value is added to the “Sequence first” value and “Sequential last” value. For example, if the “Sequence first” value is "1", the “Sequence last” value is "10", and the “Offset” value is "4", then MyObject_0005.obj would load on frame 1.
    • Ten sequential objects, looping, offset is four.
      Ten sequential objects, Ping Pong, offset is four.



      Mesh Modifiers tab[edit]

      Mesh Modifiers Tab

      Settings:

      • Read MDD (motion) file: Terragen can apply Motion Designer or “MDD” files created in third-party 3D software packages to an object within the project. The MDD file contains the position of every vertex in an object, for each frame of an animation. After an object is animated or otherwise deformed in the third-party 3D software, its vertex positions are “baked”, or saved in the MDD file format. This allows for complex animation to exist within a Terragen project, that otherwise could not.
      • Motion Designer file of animated melting sequence applied to 3D text geometry.
        Motion Designer file of animated flap cycle applied to 3D bat object.


      • Mesh displacer: The shader assigned to this parameter displaces the object’s vertices (mesh). For example, a power fractal shader can be used to displace the vertices of the 3D object or a population.
      • Animated parameters on a power fractal to deform a single 3D object.
        Animated parameters on a power fractal to deform a population.
        • The denser the object’s geometry, or more vertices it has, allows for more subtle deformations to be visible.
        • Displacement applied to non-shadered objects.
          Displacement applied to textured objects.



      Surface Shaders Tab[edit]

      Surface Shaders Tab


      Description: This tab lets you assign a surface shader to texture the object. If there was a .mtl file associated with the OBJ file, a Parts Shader with its associated nodes will be created and assigned to the Surface shader input.

      Settings:

      • Surface shader: Use this parameter to assign a surface shader to the object.
      • Displacement tolerance If you find that rough or spikey surfaces are showing problems at bucket edges, for example spikes having cut off tops, or gaps in ray traced shadows then increasing this value may help. However this can greatly increase render times. Relatively flat surfaces may render more quickly with smaller values. The default value is 1. However this is an advanced setting and you should not change it unless you have specific problem you need to address. If you are having problems try starting with 2 and then increase it by small increments until they're resolved. A value of 4 would be considered a high value.
      • Smooth polygons at terminator: This fixes self-shadow artifacts at the lighting terminator of polygonal objects where the smooth normals are inconsistent with the geometric normal. This parameter is enabled by default.
      • Comparison Smooth Polygon Terminator enabled and disabled.
      • Darken bumps at terminator: This parameter approximates self-shadow of bump maps at the lighting terminator to reduce the chance of seeing a sharp line where the surface falls into shadow. This parameter is enabled by default.
      • Comparison with Smooth Polygon Terminator and Darken bumps at terminator enabled.



      Rendering Tab[edit]

      Rendering Tab

      Settings:

      • Render mode: An object's render state can be set to “Visible”, “Invisible” or “Holdout”.
        Object's render types.
        • When set to “Holdout”, an object is visible in the rendered image as a black shape with an alpha value of zero. When using render layers the object's render state is combined with the group visibility parameter to determine its least visible setting. "Invisible" is less visible than "Holdout", which is less visible than "Visible".
        • 3D objects set to visible, holdout, and invisible.  Render layer set to visible.
          Alpha channel for 3D objects set to visible, holdout,and invisible.  Render layer set to visible.
          3D objects set to visible, holdout, and invisible.  Render layer set to holdout.
          Alpha channel for 3D objects set to visible, holdout,and invisible.  Render layer set to holdout.
          3D objects set to visible, holdout,and invisible.  Render layer set to invisible.
          Alpha channel for 3D objects set to visible, holdout,and invisible.  Render layer set to invisible.


      • Visible to other rays: When enabled, the object will be taken into account by all the rays determined by the renderer including those from the camera, direct and indirect lighting, etc. In the example below, a 100% reflective 3D object has been placed behind three coloured spheres in order to mirror the effect of the calculated rays.
        3D objects set to visible, holdout,and invisible.  Visible to other rays enabled.
        Alpha channel for 3D objects set to visible, holdout,and invisible.  Visible to other rays enabled.


      • Cast shadows: This should be checked if you want the object to cast shadows.
        3D objects set to visible, holdout,and invisible.  Cast shadows disabled.
        Alpha channel for 3D objects set to visible, holdout,and invisible.  Cast shadows disabled.


      • Double-sided surface: If this is checked object surfaces are double sided. A single sided surface is only visible from the "front", which is the direction the surface normal is pointing. If you look at it from the other direction the surface isn't visible. Double sided surfaces are visible from all directions.
      • Use smooth normals: If this is checked the object normals are interpolated to make the surface appear smooth. If it's unchecked the surface will look faceted.
      • Flip normals: Check this to flip or reverse the object normals. You might want to use this on an imported object if it has gaps or strange dark patches when rendered.
      • Render method This popup has three options.
        Render method options
        • Default: Ray Tracing is the default rendering method for an object. Typically it results in higher quality and faster rendering. When displacement is applied to a 3D object the render method should be changed to Force Displacement. When the object's render method is set to "Default", the object is rendered according to the Ray trace objects setting in the render node.
        • Force Displacement: When enabled for the object, its surfaces will be subdivided into micropolygons at render time, which allows the 3D geometry to be displaced correctly but at the expense of slightly longer render times. It is useful when you have some objects you want to render with displacement but you don't want to change how all the rest of your objects are rendered, i.e. Ray traced.
        • Force Ray Trace: When enabled for the object, its surfaces will be ray traced at render time, even if “Ray trace objects” is disabled in the Renderer settings. This can be useful when “Ray trace objects” is disabled in the Renderer in order for other 3D objects to use displacement, but you want this object to use Ray tracing for the highest quality rendering and it has not been displaced.
      • Sorting bias (metres) This parameter gives you control over the order in which objects are rendered when using the micropolygon renderer. This does not apply to objects being rendered with the ray tracer. A large positive value, e.g. 10,000,000 (or 1e7) will usually force the object to render first. A large negative value, e.g. -10,000,000 (or -1e7) will usually force the object to render last, or after the terrain. This can be useful when rendering large objects with displacement, such as a lake object that lies mostly below the displaced terrain. By setting the lake object’s sorting bias value to something like -10,000,000 forces it to render after the terrain.


      Transform Tab[edit]

      Transform tab.

      Settings:

      • Translate: This sets the position of the object.
      • Rotate: This rotates the object about its origin. The order of the values is heading, pitch then bank.
      • Scale: You can use this parameter to scale the object in the X, Y and Z directions.


      Angular Position Tab[edit]

      Angular Position Tab.

      Description: This tab has settings which use angles and distance to set the position of the rock relative to the scene origin. These settings are an alternative to using the Translate setting in the Transform tab. The diagram below shows how all the parameters relate to each other and the origin.

      Angular positions

      Settings:

      • Heading: This angle sets the rotation of the object around the scene origin, in the XY plane, increasing as you turn clockwise.
      • Elevation: This angle sets the vertical part of the position. You could think of it as the angle above or below the horizon. 90 is straight up, -90 is straight down.
      • Distance: This sets the distance from the origin, in metres.


      Import Tab[edit]

      Import Tab.

      Description: These parameters apply to .chan/.mov and FBX import.

      Settings:

      • Import offset: This setting allows you to offset the positions imported from the file. As an example, you might want the positions imported from the file to be moved 10 metres in the X direction. To do that enter 10 for the X coordinate and import the file.
      • Import scale: You can use this setting to scale values imported from the file.
      • Import Chan file: This param specifies the file to be imported. When you a choose a new file you will be prompted to import the file. If you choose not to import it immediately you can click the Import chan File button to perform the import.


      OBJ Options Tab[edit]

      OBJ Options Tab.

      Description: This tab contains settings which are specific to loading OBJ files.

      Settings:

      • Source in cm: If this is checked then Terragen interprets the measurement units in the OBJ file as being in centimetres. That's the theory, but there is currently a bug which means the units are interpreted as 10cm (decimetre) rather than 1cm. You may still need to scale the object using the Transform tab to make it the correct size.
      • Source Z up: Check this if you know the OBJ file uses Z up as opposed to Y up, which Terragen uses. This will cause the coordinates to be swapped when read from the file to match Terragen's coordinate system. If the model seems to be laying over on its side when imported you probably need to check this setting.


A parameter is an individual setting in a node parameter view which controls some aspect of the node.

The bounding box is a box which surrounds (or bounds) an object or shader. This box shows the maximum extents of the item inside it. Sometimes abbreviated as "b-box".

A shader is a program or set of instructions used in 3D computer graphics to determine the final surface properties of an object or image. This can include arbitrarily complex descriptions of light absorption and diffusion, texture mapping, reflection and refraction, shadowing, surface displacement and post-processing effects. In Terragen 2 shaders are used to construct and modify almost every element of a scene.

Literally, to change the position of something. In graphics terminology to displace a surface is to modify its geometric (3D) structure using reference data of some kind. For example, a grayscale image might be taken as input, with black areas indicating no displacement of the surface, and white indicating maximum displacement. In Terragen 2 displacement is used to create all terrain by taking heightfield or procedural data as input and using it to displace the normally flat sphere of the planet.

When Terragen renders, it divides the image up into buckets or tiles. Each bucket is rendered separately, allowing multiple buckets to be rendered at once. It also allows memory to be used more efficiently.

Literally, to change the position of something. In graphics terminology to displace a surface is to modify its geometric (3D) structure using reference data of some kind. For example, a grayscale image might be taken as input, with black areas indicating no displacement of the surface, and white indicating maximum displacement. In Terragen 2 displacement is used to create all terrain by taking heightfield or procedural data as input and using it to displace the normally flat sphere of the planet.

A single object or device in the node network which generates or modifies data and may accept input data or create output data or both, depending on its function. Nodes usually have their own settings which control the data they create or how they modify data passing through them. Nodes are connected together in a network to perform work in a network-based user interface. In Terragen 2 nodes are connected together to describe a scene.