Class cv::viz::Viz3d#
The Viz3d class represents a 3D visualizer window. This class is implicitly shared.
#include <opencv2/viz/viz3d.hpp>Collaboration diagram for cv::viz::Viz3d:
Friends#
Return |
Name |
Description |
|---|---|---|
|
Detailed Description#
The Viz3d class represents a 3D visualizer window. This class is implicitly shared.
Member Typedef Documentation#
Color#
typedef cv::viz::Color cv::viz::Viz3d::Color
KeyboardCallback#
typedef void(*) cv::viz::Viz3d::KeyboardCallback(const KeyboardEvent &, void *)
MouseCallback#
typedef void(*) cv::viz::Viz3d::MouseCallback(const MouseEvent &, void *)
Constructor & Destructor Documentation#
Viz3d()#
cv::viz::Viz3d::Viz3d(const String & window_name = String())
The constructors.
Parameters
window_name— Name of the window.
Viz3d()#
~Viz3d()#
Member Function Documentation#
addLight()#
void cv::viz::Viz3d::addLight(
const Vec3d & position,
const Vec3d & focalPoint = Vec3d(0, 0, 0),
const Color & color = Color::white(),
const Color & diffuseColor = Color::white(),
const Color & ambientColor = Color::black(),
const Color & specularColor = Color::white() )
Add a light in the scene.
Parameters
position— The position of the light.focalPoint— The point at which the light is shiningcolor— The color of the lightdiffuseColor— The diffuse color of the lightambientColor— The ambient color of the lightspecularColor— The specular color of the light
close()#
void cv::viz::Viz3d::close()
converTo3DRay()#
void cv::viz::Viz3d::converTo3DRay(
const Point3d & window_coord,
Point3d & origin,
Vec3d & direction )
Transforms a point in window coordinate system to a 3D ray in world coordinate system.
Parameters
window_coord— Point in window coordinate system.origin— Output origin of the ray.direction— Output direction of the ray.
convertToWindowCoordinates()#
void cv::viz::Viz3d::convertToWindowCoordinates(
const Point3d & pt,
Point3d & window_coord )
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.
getCamera()#
Camera cv::viz::Viz3d::getCamera()
Returns a camera object that contains intrinsic parameters of the current viewer.
getRenderingProperty()#
double cv::viz::Viz3d::getRenderingProperty(
const String & id,
int property )
Returns rendering property of a widget.
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
Parameters
id— Id of the widget.property— Property.
getScreenshot()#
cv::Mat cv::viz::Viz3d::getScreenshot()
Returns the Mat screenshot of the current scene.
getViewerPose()#
Affine3d cv::viz::Viz3d::getViewerPose()
Returns the current pose of the viewer.
getWidget()#
Widget cv::viz::Viz3d::getWidget(const String & id)
Retrieves a widget from the window.
A widget is implicitly shared; that is, if the returned widget is modified, the changes will be immediately visible in the window.
Parameters
id— The id of the widget that will be returned.
getWidgetPose()#
Affine3d cv::viz::Viz3d::getWidgetPose(const String & id)
Returns the current pose of a widget in the window.
Parameters
id— The id of the widget whose pose will be returned.
getWindowName()#
String cv::viz::Viz3d::getWindowName()
Returns the name of the window which has been set in the constructor. Viz - is prepended to the name if necessary.
getWindowSize()#
Size cv::viz::Viz3d::getWindowSize()
Returns the current size of the window.
operator=()#
registerKeyboardCallback()#
void cv::viz::Viz3d::registerKeyboardCallback(
KeyboardCallback callback,
void * cookie = 0 )
Sets keyboard handler.
Parameters
callback— Keyboard callback (void (KeyboardCallbackFunction(const KeyboardEvent&, void)).cookie— The optional parameter passed to the callback.
registerMouseCallback()#
void cv::viz::Viz3d::registerMouseCallback(
MouseCallback callback,
void * cookie = 0 )
Sets mouse handler.
Parameters
callback— Mouse callback (void (MouseCallback)(const MouseEvent&, void)).cookie— The optional parameter passed to the callback.
removeAllLights()#
void cv::viz::Viz3d::removeAllLights()
Remove all lights from the current scene.
removeAllWidgets()#
void cv::viz::Viz3d::removeAllWidgets()
Removes all widgets from the window.
removeWidget()#
void cv::viz::Viz3d::removeWidget(const String & id)
Removes a widget from the window.
Parameters
id— The id of the widget that will be removed.
resetCamera()#
void cv::viz::Viz3d::resetCamera()
Resets camera.
resetCameraViewpoint()#
void cv::viz::Viz3d::resetCameraViewpoint(const String & id)
Resets camera viewpoint to a 3D widget in the scene.
Parameters
id— Id of a 3D widget.
saveScreenshot()#
void cv::viz::Viz3d::saveScreenshot(const String & file)
Saves screenshot of the current scene.
Parameters
file— Name of the file.
setBackgroundColor()#
void cv::viz::Viz3d::setBackgroundColor(
const Color & color = Color::black(),
const Color & color2 = Color::not_set() )
Sets background color.
setBackgroundMeshLab()#
void cv::viz::Viz3d::setBackgroundMeshLab()
setBackgroundTexture()#
void cv::viz::Viz3d::setBackgroundTexture(InputArray image = noArray())
Here is the call graph for this function:
setCamera()#
void cv::viz::Viz3d::setCamera(const Camera & camera)
Sets the intrinsic parameters of the viewer using Camera.
Parameters
camera— Camera object wrapping intrinsic parameters.
setFullScreen()#
void cv::viz::Viz3d::setFullScreen(bool mode = true)
Sets or unsets full-screen rendering mode.
Parameters
mode— If true, window will use full-screen mode.
setGlobalWarnings()#
void cv::viz::Viz3d::setGlobalWarnings(bool enabled = false)
setOffScreenRendering()#
void cv::viz::Viz3d::setOffScreenRendering()
Create a window in memory instead of on the screen.
setRenderingProperty()#
void cv::viz::Viz3d::setRenderingProperty(
const String & id,
int property,
double value )
Sets rendering property of a widget.
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
Parameters
id— Id of the widget.property— Property that will be modified.value— The new value of the property.
setRepresentation()#
void cv::viz::Viz3d::setRepresentation(int representation)
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
setViewerPose()#
void cv::viz::Viz3d::setViewerPose(const Affine3d & pose)
Sets pose of the viewer.
Parameters
pose— The new pose of the viewer.
setWidgetPose()#
void cv::viz::Viz3d::setWidgetPose(
const String & id,
const Affine3d & pose )
Sets pose of a widget in the window.
Parameters
id— The id of the widget whose pose will be set.pose— The new pose of the widget.
setWindowPosition()#
void cv::viz::Viz3d::setWindowPosition(const Point & window_position)
Sets the position of the window in the screen.
Parameters
window_position— coordinates of the window
setWindowSize()#
void cv::viz::Viz3d::setWindowSize(const Size & window_size)
Sets the size of the window.
Parameters
window_size— New size of the window.
showImage()#
void cv::viz::Viz3d::showImage(
InputArray image,
const Size & window_size = Size(-1, -1) )
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.
showWidget()#
void cv::viz::Viz3d::showWidget(
const String & id,
const Widget & widget,
const Affine3d & pose = Affine3d::Identity() )
Shows a widget in the window.
Parameters
id— A unique id for the widget.widget— The widget to be displayed in the window.pose— Pose of the widget.
spin()#
void cv::viz::Viz3d::spin()
The window renders and starts the event loop.
spinOnce()#
void cv::viz::Viz3d::spinOnce(
int time = 1,
bool force_redraw = false )
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.
updateWidgetPose()#
void cv::viz::Viz3d::updateWidgetPose(
const String & id,
const Affine3d & pose )
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.pose— The pose that the current pose of the widget will be pre-multiplied by.
wasStopped()#
bool cv::viz::Viz3d::wasStopped()
Returns whether the event loop has been stopped.
create()#
release()#
void cv::viz::Viz3d::release()
Member Data Documentation#
impl_#
VizImpl * cv::viz::Viz3d::impl_
Source file#
The documentation for this class was generated from the following file:
opencv2/viz/viz3d.hpp