Struct Viz3d

pub struct Viz3d { /* private fields */ }

The Viz3d class represents a 3D visualizer window. This class is implicitly shared.

Implementations

impl Viz3d

pub fn new(window_name: &str) -> Result<Viz3d>

The constructors.

Parameters

• window_name: Name of the window.

C++ default parameters

• window_name: String()

pub fn new_def() -> Result<Viz3d>

The constructors.

Parameters

• window_name: Name of the window.

Note

This alternative version of [new] function uses the following default values for its arguments:

• window_name: String()

pub fn copy(unnamed: &impl Viz3dTraitConst) -> Result<Viz3d>

Trait Implementations

impl Boxed for Viz3d

unsafe fn from_raw(ptr: <Viz3d as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <Viz3d as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <Viz3d as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut(&mut self) -> <Viz3d as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for Viz3d

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Viz3d

fn drop(&mut self)

Executes the destructor for this type.

impl Viz3dTrait for Viz3d

fn as_raw_mut_Viz3d(&mut self) -> *mut c_void

fn set(&mut self, unnamed: &impl Viz3dTraitConst) -> Result<()>

fn show_widget( &mut self, id: &str, widget: &impl WidgetTraitConst, pose: Affine3d, ) -> Result<()>

Shows a widget in the window.

fn show_widget_def( &mut self, id: &str, widget: &impl WidgetTraitConst, ) -> Result<()>

Shows a widget in the window.

fn remove_widget(&mut self, id: &str) -> Result<()>

Removes a widget from the window.

fn remove_all_widgets(&mut self) -> Result<()>

Removes all widgets from the window.

fn show_image( &mut self, image: &impl ToInputArray, window_size: Size, ) -> Result<()>

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

fn show_image_def(&mut self, image: &impl ToInputArray) -> Result<()>

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

fn set_widget_pose(&mut self, id: &str, pose: Affine3d) -> Result<()>

Sets pose of a widget in the window.

fn update_widget_pose(&mut self, id: &str, pose: Affine3d) -> Result<()>

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

fn set_camera(&mut self, camera: &impl CameraTraitConst) -> Result<()>

Sets the intrinsic parameters of the viewer using Camera.

fn set_viewer_pose(&mut self, pose: Affine3d) -> Result<()>

Sets pose of the viewer.

fn reset_camera_viewpoint(&mut self, id: &str) -> Result<()>

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

fn reset_camera(&mut self) -> Result<()>

Resets camera.

fn convert_to_window_coordinates( &mut self, pt: Point3d, window_coord: &mut Point3d, ) -> Result<()>

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

fn conver_to_3d_ray( &mut self, window_coord: Point3d, origin: &mut Point3d, direction: &mut Vec3d, ) -> Result<()>

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

fn set_window_size(&mut self, window_size: Size) -> Result<()>

Sets the size of the window.

fn save_screenshot(&mut self, file: &str) -> Result<()>

Saves screenshot of the current scene.

fn set_window_position(&mut self, window_position: Point) -> Result<()>

Sets the position of the window in the screen.

fn set_full_screen(&mut self, mode: bool) -> Result<()>

Sets or unsets full-screen rendering mode.

fn set_full_screen_def(&mut self) -> Result<()>

Sets or unsets full-screen rendering mode.

fn set_background_color( &mut self, color: &impl ColorTraitConst, color2: &impl ColorTraitConst, ) -> Result<()>

Sets background color.

fn set_background_color_def(&mut self) -> Result<()>

Sets background color.

fn set_background_texture(&mut self, image: &impl ToInputArray) -> Result<()>

C++ default parameters

fn set_background_texture_def(&mut self) -> Result<()>

Note

fn set_background_mesh_lab(&mut self) -> Result<()>

fn spin(&mut self) -> Result<()>

The window renders and starts the event loop.

fn spin_once(&mut self, time: i32, force_redraw: bool) -> Result<()>

Starts the event loop for a given time.

fn spin_once_def(&mut self) -> Result<()>

Starts the event loop for a given time.

fn set_off_screen_rendering(&mut self) -> Result<()>

Create a window in memory instead of on the screen.

fn remove_all_lights(&mut self) -> Result<()>

Remove all lights from the current scene.

fn add_light( &mut self, position: Vec3d, focal_point: Vec3d, color: &impl ColorTraitConst, diffuse_color: &impl ColorTraitConst, ambient_color: &impl ColorTraitConst, specular_color: &impl ColorTraitConst, ) -> Result<()>

Add a light in the scene.

fn add_light_def(&mut self, position: Vec3d) -> Result<()>

Add a light in the scene.

fn close(&mut self) -> Result<()>

fn register_keyboard_callback( &mut self, callback: Viz3d_KeyboardCallback, ) -> Result<()>

Sets keyboard handler.

fn register_mouse_callback( &mut self, callback: Viz3d_MouseCallback, ) -> Result<()>

Sets mouse handler.

fn set_rendering_property( &mut self, id: &str, property: i32, value: f64, ) -> Result<()>

Sets rendering property of a widget.

fn get_rendering_property(&mut self, id: &str, property: i32) -> Result<f64>

Returns rendering property of a widget.

fn set_representation(&mut self, representation: i32) -> Result<()>

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

fn set_global_warnings(&mut self, enabled: bool) -> Result<()>

C++ default parameters

fn set_global_warnings_def(&mut self) -> Result<()>

Note

impl Viz3dTraitConst for Viz3d

fn as_raw_Viz3d(&self) -> *const c_void

fn get_widget(&self, id: &str) -> Result<Widget>

Retrieves a widget from the window.

fn get_widget_pose(&self, id: &str) -> Result<Affine3d>

Returns the current pose of a widget in the window.

fn get_camera(&self) -> Result<Camera>

Returns a camera object that contains intrinsic parameters of the current viewer.

fn get_viewer_pose(&self) -> Result<Affine3d>

Returns the current pose of the viewer.

fn get_window_size(&self) -> Result<Size>

Returns the current size of the window.

fn get_window_name(&self) -> Result<String>

Returns the name of the window which has been set in the constructor. Viz - is prepended to the name if necessary.

fn get_screenshot(&self) -> Result<Mat>

Returns the Mat screenshot of the current scene.

fn was_stopped(&self) -> Result<bool>

Returns whether the event loop has been stopped.

impl Send for Viz3d