Trait opencv::viz::Viz3dTrait

source · [−]
pub trait Viz3dTrait: Viz3dTraitConst {

Show 32 methods    fn as_raw_mut_Viz3d(&mut self) -> *mut c_void;

    fn show_widget(
        &mut self,
        id: &str,
        widget: &Widget,
        pose: Affine3d
    ) -> Result<()> { ... }
    fn remove_widget(&mut self, id: &str) -> Result<()> { ... }
    fn remove_all_widgets(&mut self) -> Result<()> { ... }
    fn show_image(
        &mut self,
        image: &dyn ToInputArray,
        window_size: Size
    ) -> Result<()> { ... }
    fn set_widget_pose(&mut self, id: &str, pose: Affine3d) -> Result<()> { ... }
    fn update_widget_pose(&mut self, id: &str, pose: Affine3d) -> Result<()> { ... }
    fn set_camera(&mut self, camera: &Camera) -> Result<()> { ... }
    fn set_viewer_pose(&mut self, pose: Affine3d) -> Result<()> { ... }
    fn reset_camera_viewpoint(&mut self, id: &str) -> Result<()> { ... }
    fn reset_camera(&mut self) -> Result<()> { ... }
    fn convert_to_window_coordinates(
        &mut self,
        pt: Point3d,
        window_coord: &mut Point3d
    ) -> Result<()> { ... }
    fn conver_to3_d_ray(
        &mut self,
        window_coord: Point3d,
        origin: &mut Point3d,
        direction: &mut Vec3d
    ) -> Result<()> { ... }
    fn set_window_size(&mut self, window_size: Size) -> Result<()> { ... }
    fn save_screenshot(&mut self, file: &str) -> Result<()> { ... }
    fn set_window_position(&mut self, window_position: Point) -> Result<()> { ... }
    fn set_full_screen(&mut self, mode: bool) -> Result<()> { ... }
    fn set_background_color(
        &mut self,
        color: &Viz3d_Color,
        color2: &Viz3d_Color
    ) -> Result<()> { ... }
    fn set_background_texture(&mut self, image: &dyn ToInputArray) -> Result<()> { ... }
    fn set_background_mesh_lab(&mut self) -> Result<()> { ... }
    fn spin(&mut self) -> Result<()> { ... }
    fn spin_once(&mut self, time: i32, force_redraw: bool) -> Result<()> { ... }
    fn set_off_screen_rendering(&mut self) -> Result<()> { ... }
    fn remove_all_lights(&mut self) -> Result<()> { ... }
    fn add_light(
        &mut self,
        position: Vec3d,
        focal_point: Vec3d,
        color: &Viz3d_Color,
        diffuse_color: &Viz3d_Color,
        ambient_color: &Viz3d_Color,
        specular_color: &Viz3d_Color
    ) -> Result<()> { ... }
    fn close(&mut self) -> Result<()> { ... }
    fn register_keyboard_callback(
        &mut self,
        callback: Viz3d_KeyboardCallback
    ) -> Result<()> { ... }
    fn register_mouse_callback(
        &mut self,
        callback: Viz3d_MouseCallback
    ) -> Result<()> { ... }
    fn set_rendering_property(
        &mut self,
        id: &str,
        property: i32,
        value: f64
    ) -> Result<()> { ... }
    fn get_rendering_property(&mut self, id: &str, property: i32) -> Result<f64> { ... }
    fn set_representation(&mut self, representation: i32) -> Result<()> { ... }
    fn set_global_warnings(&mut self, enabled: bool) -> Result<()> { ... }

}

Required Methods

Provided Methods

Shows a widget in the window.

Parameters
  • id: A unique id for the widget. @param widget The widget to be displayed in the window.
  • pose: Pose of the widget.
C++ default parameters
  • pose: Affine3d::Identity()

Removes a widget from the window.

Parameters
  • id: The id of the widget that will be removed.

Removes all widgets from the window.

Removed all widgets and displays image scaled to whole window area.

Parameters
  • image: Image to be displayed.
  • window_size: Size of Viz3d window. Default value means no change.
C++ default parameters
  • window_size: Size(-1,-1)

Sets pose of a widget in the window.

Parameters
  • id: The id of the widget whose pose will be set. @param pose The new pose of the widget.

Updates pose of a widget in the window by pre-multiplying its current pose.

Parameters
  • id: The id of the widget whose pose will be updated. @param pose The pose that the current pose of the widget will be pre-multiplied by.

Sets the intrinsic parameters of the viewer using Camera.

Parameters
  • camera: Camera object wrapping intrinsic parameters.

Sets pose of the viewer.

Parameters
  • pose: The new pose of the viewer.

Resets camera viewpoint to a 3D widget in the scene.

Parameters
  • id: Id of a 3D widget.

Resets camera.

Transforms a point in world coordinate system to window coordinate system.

Parameters
  • pt: Point in world coordinate system.
  • window_coord: Output point in window coordinate system.

Transforms a point in window coordinate system to a 3D ray in world coordinate system.

Parameters
  • window_coord: Point in window coordinate system. @param origin Output origin of the ray.
  • direction: Output direction of the ray.

Sets the size of the window.

Parameters
  • window_size: New size of the window.

Saves screenshot of the current scene.

Parameters
  • file: Name of the file.

Sets the position of the window in the screen.

Parameters
  • window_position: coordinates of the window

Sets or unsets full-screen rendering mode.

Parameters
  • mode: If true, window will use full-screen mode.
C++ default parameters
  • mode: true

Sets background color.

C++ default parameters
  • color: Color::black()
  • color2: Color::not_set()
C++ default parameters
  • image: noArray()

The window renders and starts the event loop.

Starts the event loop for a given time.

Parameters
  • time: Amount of time in milliseconds for the event loop to keep running.
  • force_redraw: If true, window renders.
C++ default parameters
  • time: 1
  • force_redraw: false

Create a window in memory instead of on the screen.

Remove all lights from the current scene.

Add a light in the scene.

Parameters
  • position: The position of the light.
  • focalPoint: The point at which the light is shining
  • color: The color of the light
  • diffuseColor: The diffuse color of the light
  • ambientColor: The ambient color of the light
  • specularColor: The specular color of the light
C++ default parameters
  • focal_point: Vec3d(0,0,0)
  • color: Color::white()
  • diffuse_color: Color::white()
  • ambient_color: Color::black()
  • specular_color: Color::white()

Sets keyboard handler.

Parameters
  • callback: Keyboard callback (void (*KeyboardCallbackFunction(const KeyboardEvent&, void*)).
  • cookie: The optional parameter passed to the callback.
C++ default parameters
  • cookie: 0

Sets mouse handler.

Parameters
  • callback: Mouse callback (void (*MouseCallback)(const MouseEvent&, void*)).
  • cookie: The optional parameter passed to the callback.
C++ default parameters
  • cookie: 0

Sets rendering property of a widget.

Parameters
  • id: Id of the widget.
  • property: Property that will be modified.
  • value: The new value of the property.

Rendering property can be one of the following:

  • POINT_SIZE
  • OPACITY
  • LINE_WIDTH
  • FONT_SIZE

REPRESENTATION: Expected values are

  • REPRESENTATION_POINTS
  • REPRESENTATION_WIREFRAME
  • REPRESENTATION_SURFACE

IMMEDIATE_RENDERING:

  • Turn on immediate rendering by setting the value to 1.
  • Turn off immediate rendering by setting the value to 0.

SHADING: Expected values are

  • SHADING_FLAT
  • SHADING_GOURAUD
  • SHADING_PHONG

Returns rendering property of a widget.

Parameters
  • id: Id of the widget.
  • property: Property.

Rendering property can be one of the following:

  • POINT_SIZE
  • OPACITY
  • LINE_WIDTH
  • FONT_SIZE

REPRESENTATION: Expected values are

  • REPRESENTATION_POINTS
  • REPRESENTATION_WIREFRAME
  • REPRESENTATION_SURFACE

IMMEDIATE_RENDERING:

  • Turn on immediate rendering by setting the value to 1.
  • Turn off immediate rendering by setting the value to 0.

SHADING: Expected values are

  • SHADING_FLAT
  • SHADING_GOURAUD
  • SHADING_PHONG

Sets geometry representation of the widgets to surface, wireframe or points.

Parameters
  • representation: Geometry representation which can be one of the following:
  • REPRESENTATION_POINTS
  • REPRESENTATION_WIREFRAME
  • REPRESENTATION_SURFACE
C++ default parameters
  • enabled: false

Implementors