| OpenCV 3.4.1 Open Source Computer Vision

Classes | Enumerations | Functions
OGRE 3D Visualiser

## Classes
class | cv::ovis::WindowScene

## Enumerations
enum | cv::ovis::MaterialProperty { cv::ovis::MATERIAL_POINT_SIZE, cv::ovis::MATERIAL_OPACITY, cv::ovis::MATERIAL_EMISSIVE, cv::ovis::MATERIAL_TEXTURE }
enum | cv::ovis::SceneSettings { cv::ovis::SCENE_SEPERATE = 1, cv::ovis::SCENE_INTERACTIVE = 2, cv::ovis::SCENE_SHOW_CS_CROSS = 4, cv::ovis::SCENE_RENDER_FLOAT = 8, cv::ovis::SCENE_AA = 16 }

## Functions
void | cv::ovis::addResourceLocation (const String &path)
void | cv::ovis::createGridMesh (const String &name, const Size2f &size, const Size &segments=Size(1, 1))
void | cv::ovis::createPlaneMesh (const String &name, const Size2f &size, InputArray image=noArray())
void | cv::ovis::createPointCloudMesh (const String &name, InputArray vertices, InputArray colors=noArray())
Ptr< WindowScene > | cv::ovis::createWindow (const String &title, const Size &size, int flags=SCENE_INTERACTIVE|SCENE_AA)
void | cv::ovis::setMaterialProperty (const String &name, int prop, const Scalar &value)
void | cv::ovis::setMaterialProperty (const String &name, int prop, const String &value)
void | cv::ovis::setMaterialProperty (const String &name, const String &prop, const Scalar &value)
int | cv::ovis::waitKey (int delay=0)

## Detailed Description

## Enumeration Type Documentation

## § MaterialProperty

enum cv::ovis::MaterialProperty

Enumerator
MATERIAL_POINT_SIZE |
MATERIAL_OPACITY |
MATERIAL_EMISSIVE |
MATERIAL_TEXTURE |

## § SceneSettings

enum cv::ovis::SceneSettings

Enumerator
SCENE_SEPERATE | the window will use a seperate scene. The scene will be shared otherwise.
SCENE_INTERACTIVE | allow the user to control the camera.
SCENE_SHOW_CS_CROSS | draw coordinate system crosses for debugging
SCENE_RENDER_FLOAT | WindowScene::getScreenshot returns images as CV_32FC4 instead of CV_8UC3
SCENE_AA | Apply anti-aliasing. The first window determines the setting for all windows.

## Function Documentation

## § addResourceLocation()

void cv::ovis::addResourceLocation | ( | const String & | path | ) |

Add an additional resource location that is search for meshes, textures and materials

must be called before the first createWindow. If give path does not exist, retries inside Ogre Media Directory.

Parameters

  path | folder or Zip archive.

## § createGridMesh()

void cv::ovis::createGridMesh | ( | const String & | name,
|  | const Size2f & | size,
|  | const Size & | segments = `Size(1, 1)`
| ) |  |

creates a grid

creates a material with the same name

Parameters

  name | name of the mesh
  size | extents of the grid
  segments | number of segments per side

## § createPlaneMesh()

void cv::ovis::createPlaneMesh | ( | const String & | name,
|  | const Size2f & | size,
|  | InputArray | image = `noArray()`
| ) |  |

create a 2D plane, X right, Y down, Z up

creates a material and a texture with the same name

Parameters

  name | name of the mesh
  size | size in world units
  image | optional texture

## § createPointCloudMesh()

void cv::ovis::createPointCloudMesh | ( | const String & | name,
|  | InputArray | vertices,
|  | InputArray | colors = `noArray()`
| ) |  |

creates a point cloud mesh

creates a material with the same name

Parameters

  name | name of the mesh
  vertices | float vector of positions
  colors | uchar vector of colors

## § createWindow()

Ptr<WindowScene> cv::ovis::createWindow | ( | const String & | title,
|  | const Size & | size,
|  | int | flags = `SCENE_INTERACTIVE|SCENE_AA`
| ) |  |

create a new rendering window/ viewport

Parameters

  title | window title
  size | size of the window
  flags | a combination of SceneSettings

## § setMaterialProperty() [1/3]

void cv::ovis::setMaterialProperty | ( | const String & | name,
|  | int | prop,
|  | const Scalar & | value
| ) |  |

set the property of a material to the given value

Parameters

  name | material name
  prop | MaterialProperty
  value | the value

## § setMaterialProperty() [2/3]

void cv::ovis::setMaterialProperty | ( | const String & | name,
|  | int | prop,
|  | const String & | value
| ) |  |

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

## § setMaterialProperty() [3/3]

void cv::ovis::setMaterialProperty | ( | const String & | name,
|  | const String & | prop,
|  | const Scalar & | value
| ) |  |

set the shader property of a material to the given value

Parameters

  name | material name
  prop | property name
  value | the value

## § waitKey()

int cv::ovis::waitKey | ( | int | delay = `0` | ) |

update all windows and wait for keyboard event

Parameters

  delay | 0 is the special value that means "forever". Any positive number returns after sync to blank (typically 16ms).

Returns
  the code of the pressed key or -1 if no key was pressed