Module opencv::ovis

OGRE 3D Visualiser

ovis is a simplified rendering wrapper around ogre3d. The Ogre terminology is used in the API and Ogre Script is assumed to be used for advanced customization.

Besides the API you see here, there are several environment variables that control the behavior of ovis. They are documented in [createWindow].

Loading geometry

You can create geometry on the fly or by loading Ogre .mesh files.

Blender

For converting/ creating geometry Blender is recommended.

• Blender 2.7x is better tested, but Blender 2.8x should work too
• install blender2ogre matching your Blender version
• download the Ogre MSVC SDK which contains OgreXMLConverter.exe (in bin/) and set the path in the blender2ogre settings
• get ogre-meshviewer to enable the preview function in blender2ogre as well as for verifying the exported files
• in case the exported materials are not exactly how you want them, consult the Ogre Manual

Assimp

When using Ogre 1.12.9 or later, enabling the Assimp plugin allows to load arbitrary geometry. Simply pass bunny.obj instead of bunny.mesh as meshname in [WindowScene::createEntity].

You should still use ogre-meshviewer to verify that the geometry is converted correctly.

Modules

• prelude

Structs

• WindowScene
  A 3D viewport and the associated scene

Enums

• EntityProperty
• MaterialProperty
• SceneSettings

Constants

• ENTITY_AABB_WORLD
• ENTITY_ANIMBLEND_MODE
• ENTITY_CAST_SHADOWS
• ENTITY_MATERIAL
• ENTITY_SCALE
• MATERIAL_DIFFUSE
• MATERIAL_EMISSIVE
• MATERIAL_LINE_WIDTH
• MATERIAL_OPACITY
• MATERIAL_POINT_SIZE
• MATERIAL_TEXTURE
• MATERIAL_TEXTURE0
• MATERIAL_TEXTURE1
• MATERIAL_TEXTURE2
• MATERIAL_TEXTURE3
• SCENE_AA
  Apply anti-aliasing. The first window determines the setting for all windows.
• SCENE_INTERACTIVE
  allow the user to control the camera.
• SCENE_OFFSCREEN
  Render off-screen without a window. Allows separate AA setting. Requires manual update via WindowScene::update
• SCENE_SEPARATE
  the window will use a separate scene. The scene will be shared otherwise.
• SCENE_SHADOWS
  Enable real-time shadows in the scene. All entities cast shadows by default. Control via ENTITY_CAST_SHADOWS
• SCENE_SHOW_CS_CROSS
  draw coordinate system crosses for debugging

Traits

• WindowSceneTrait
  Mutable methods for crate::ovis::WindowScene
• WindowSceneTraitConst
  Constant methods for crate::ovis::WindowScene

Functions

• add_resource_location
  Add an additional resource location that is search for meshes, textures and materials
• create_grid_mesh
  creates a grid
• create_plane_mesh
  create a 2D plane, X right, Y down, Z up
• create_point_cloud_mesh
  creates a point cloud mesh
• create_triangle_mesh
  creates a triangle mesh from vertex-vertex or face-vertex representation
• create_window
  create a new rendering window/ viewport
• set_material_property
  set the property of a material to the given value
• set_material_property_1
  set the property of a material to the given value
• set_material_property_2
  set the shader property of a material to the given value
• set_material_texture
  set the texture of a material to the given value
• update_textureDeprecated
  Deprecated: use setMaterialProperty
• wait_key
  update all windows and wait for keyboard event