| | |
- mrpt.pymrpt.mrpt.system.CObservable(pybind11_builtins.pybind11_object)
-
- CBaseGUIWindow
-
- CDisplayWindow
- CDisplayWindow3D
- CDisplayWindowPlots
- mrpt.pymrpt.mrpt.system.mrptEvent(pybind11_builtins.pybind11_object)
-
- mrptEvent3DWindowGrabImageFile
- mrptEventMouseDown
- mrptEventMouseMove
- mrptEventWindowChar
- mrptEventWindowClosed
- mrptEventWindowResize
- mrpt.pymrpt.nanogui.GLCanvas(pybind11_builtins.pybind11_object)
-
- MRPT2NanoguiGLCanvas
- mrpt.pymrpt.nanogui.Screen(pybind11_builtins.pybind11_object)
-
- CDisplayWindowGUI
- pybind11_builtins.pybind11_object(builtins.object)
-
- CDisplayWindow3DLocker
- CDisplayWindowGUI_Params
- CGlCanvasBase
-
- CGlCanvasBaseHeadless
- mrptKeyCode
- mrptKeyModifier
class CBaseGUIWindow(mrpt.pymrpt.mrpt.system.CObservable) |
| |
The base class for GUI window classes based on wxWidgets.
This class can be observed (see mrpt::system::CObserver) for the following
events (see mrpt::system::mrptEvent):
- mrpt::gui::mrptEventWindowChar
- mrpt::gui::mrptEventWindowResize
- mrpt::gui::mrptEventMouseDown
- mrpt::gui::mrptEventWindowClosed
See derived classes to check if they emit other additional events.
IMPORTANTE NOTICE: Event handlers in your observer class will be invoked
from the wxWidgets internal MRPT thread, so all your code in the handler
must be thread safe.
|
| |
- Method resolution order:
- CBaseGUIWindow
- mrpt.pymrpt.mrpt.system.CObservable
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, arg0: capsule, arg1: int, arg2: int) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, winobj_voidptr: capsule, CMD_CREATE_WIN: int, CMD_DESTROY_WIN: int, initial_caption: str) -> None
- clearKeyHitFlag(...)
- clearKeyHitFlag(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Assure that "keyHit" will return false until the next pushed key.
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::clearKeyHitFlag() --> void
- getLastMousePosition(...)
- getLastMousePosition(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, x: int, y: int) -> bool
Gets the last x,y pixel coordinates of the mouse.
False if the
window is closed.
C++: mrpt::gui::CBaseGUIWindow::getLastMousePosition(int &, int &) const --> bool
- getPushedKey(...)
- getPushedKey(*args, **kwargs)
Overloaded function.
1. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Returns the latest pushed key, or 0 if there is no new key stroke.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in <mrpt/gui/keycodes.h> (a
replication of wxWidgets key codes).
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::getPushedKey(enum mrpt::gui::mrptKeyModifier *) --> int
- getWxObject(...)
- getWxObject(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> capsule
Read-only access to the wxDialog object.
C++: mrpt::gui::CBaseGUIWindow::getWxObject() --> void *
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns false if the user has already closed the window.
C++: mrpt::gui::CBaseGUIWindow::isOpen() --> bool
- keyHit(...)
- keyHit(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns true if a key has been pushed, without blocking waiting for a
new key being pushed.
waitForKey, clearKeyHitFlag
C++: mrpt::gui::CBaseGUIWindow::keyHit() const --> bool
- notifyChildWindowDestruction(...)
- notifyChildWindowDestruction(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to set m_hwnd to NULL.
C++: mrpt::gui::CBaseGUIWindow::notifyChildWindowDestruction() --> void
- notifySemThreadReady(...)
- notifySemThreadReady(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to signal the semaphore that the wx window is
built and ready.
C++: mrpt::gui::CBaseGUIWindow::notifySemThreadReady() --> void
- resize(...)
- resize(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, width: int, height: int) -> None
Resizes the window, stretching the image to fit into the display area.
C++: mrpt::gui::CBaseGUIWindow::resize(unsigned int, unsigned int) --> void
- setCursorCross(...)
- setCursorCross(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, cursorIsCross: bool) -> None
Set cursor style to default (cursorIsCross=false) or to a cross
(cursorIsCross=true)
C++: mrpt::gui::CBaseGUIWindow::setCursorCross(bool) --> void
- setPos(...)
- setPos(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, x: int, y: int) -> None
Changes the position of the window on the screen.
C++: mrpt::gui::CBaseGUIWindow::setPos(int, int) --> void
- setWindowTitle(...)
- setWindowTitle(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, str: str) -> None
Changes the window title text.
C++: mrpt::gui::CBaseGUIWindow::setWindowTitle(const std::string &) --> void
- waitForKey(...)
- waitForKey(*args, **kwargs)
Overloaded function.
1. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool) -> int
3. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Waits for any key to be pushed on the image or the console, and returns
the key code.
This method remove key strokes previous to its call, so it will always
wait. To get
the latest pushed key, see
If set to false, any push of shift, cmd,
control, etc... will make this method to return.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in mrptKeyCode (a replication
of wxWidgets key codes).
getPushedKey, Key codes in the enum mrptKeyCode
C++: mrpt::gui::CBaseGUIWindow::waitForKey(bool, enum mrpt::gui::mrptKeyModifier *) --> int
Methods inherited from mrpt.pymrpt.mrpt.system.CObservable:
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.system.CObservable, : mrpt.pymrpt.mrpt.system.CObservable) -> mrpt.pymrpt.mrpt.system.CObservable
C++: mrpt::system::CObservable::operator=(const class mrpt::system::CObservable &) --> class mrpt::system::CObservable &
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class CDisplayWindow(CBaseGUIWindow) |
| |
This class creates a window as a graphical user interface (GUI) for
displaying images to the user.
For a list of supported events with the observer/observable pattern, see the
discussion in mrpt::gui::CBaseGUIWindow.
|
| |
- Method resolution order:
- CDisplayWindow
- CBaseGUIWindow
- mrpt.pymrpt.mrpt.system.CObservable
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, arg0: str) -> None
doc
3. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, arg0: str, arg1: int) -> None
doc
4. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, windowCaption: str, initWidth: int, initHeight: int) -> None
- enableCursorCoordinatesVisualization(...)
- enableCursorCoordinatesVisualization(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, enable: bool) -> None
Enables or disables the visualization of cursor coordinates on the
window caption (default = enabled).
C++: mrpt::gui::CDisplayWindow::enableCursorCoordinatesVisualization(bool) --> void
- getLastMousePosition(...)
- getLastMousePosition(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, x: int, y: int) -> bool
Gets the last x,y pixel coordinates of the mouse.
False if the
window is closed.
C++: mrpt::gui::CDisplayWindow::getLastMousePosition(int &, int &) const --> bool
- plot(...)
- plot(*args, **kwargs)
Overloaded function.
1. plot(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, x: mrpt::math::CVectorDynamic<float>, y: mrpt::math::CVectorDynamic<float>) -> None
Plots a graph in MATLAB-like style.
C++: mrpt::gui::CDisplayWindow::plot(const class mrpt::math::CVectorDynamic<float> &, const class mrpt::math::CVectorDynamic<float> &) --> void
2. plot(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, y: mrpt::math::CVectorDynamic<float>) -> None
Plots a graph in MATLAB-like style.
C++: mrpt::gui::CDisplayWindow::plot(const class mrpt::math::CVectorDynamic<float> &) --> void
- resize(...)
- resize(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, width: int, height: int) -> None
Resizes the window, stretching the image to fit into the display area.
C++: mrpt::gui::CDisplayWindow::resize(unsigned int, unsigned int) --> void
- setCursorCross(...)
- setCursorCross(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, cursorIsCross: bool) -> None
Set cursor style to default (cursorIsCross=false) or to a cross
(cursorIsCross=true)
C++: mrpt::gui::CDisplayWindow::setCursorCross(bool) --> void
- setPos(...)
- setPos(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, x: int, y: int) -> None
Changes the position of the window on the screen.
C++: mrpt::gui::CDisplayWindow::setPos(int, int) --> void
- setWindowTitle(...)
- setWindowTitle(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, str: str) -> None
Changes the window title text.
C++: mrpt::gui::CDisplayWindow::setWindowTitle(const std::string &) --> void
- showImage(...)
- showImage(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, img: mrpt.pymrpt.mrpt.img.CImage) -> None
Show a given color or grayscale image on the window.
It adapts the size of the window to that of the image.
C++: mrpt::gui::CDisplayWindow::showImage(const class mrpt::img::CImage &) --> void
- showImageAndPoints(...)
- showImageAndPoints(*args, **kwargs)
Overloaded function.
1. showImageAndPoints(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, img: mrpt.pymrpt.mrpt.img.CImage, x: mrpt::math::CVectorDynamic<float>, y: mrpt::math::CVectorDynamic<float>) -> None
2. showImageAndPoints(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, img: mrpt.pymrpt.mrpt.img.CImage, x: mrpt::math::CVectorDynamic<float>, y: mrpt::math::CVectorDynamic<float>, color: mrpt.pymrpt.mrpt.img.TColor) -> None
3. showImageAndPoints(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow, img: mrpt.pymrpt.mrpt.img.CImage, x: mrpt::math::CVectorDynamic<float>, y: mrpt::math::CVectorDynamic<float>, color: mrpt.pymrpt.mrpt.img.TColor, showNumbers: bool) -> None
Show a given color or grayscale image on the window and print a set of
points on it.
It adapts the size of the window to that of the image.
C++: mrpt::gui::CDisplayWindow::showImageAndPoints(const class mrpt::img::CImage &, const class mrpt::math::CVectorDynamic<float> &, const class mrpt::math::CVectorDynamic<float> &, const struct mrpt::img::TColor &, bool) --> void
Static methods defined here:
- Create(...) from builtins.PyCapsule
- Create(*args, **kwargs)
Overloaded function.
1. Create(windowCaption: str) -> mrpt.pymrpt.mrpt.gui.CDisplayWindow
2. Create(windowCaption: str, initWidth: int) -> mrpt.pymrpt.mrpt.gui.CDisplayWindow
3. Create(windowCaption: str, initWidth: int, initHeight: int) -> mrpt.pymrpt.mrpt.gui.CDisplayWindow
Class factory returning a smart pointer, equivalent to
`std::make_shared<>(...)`
C++: mrpt::gui::CDisplayWindow::Create(const std::string &, unsigned int, unsigned int) --> class std::shared_ptr<class mrpt::gui::CDisplayWindow>
Methods inherited from CBaseGUIWindow:
- clearKeyHitFlag(...)
- clearKeyHitFlag(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Assure that "keyHit" will return false until the next pushed key.
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::clearKeyHitFlag() --> void
- getPushedKey(...)
- getPushedKey(*args, **kwargs)
Overloaded function.
1. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Returns the latest pushed key, or 0 if there is no new key stroke.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in <mrpt/gui/keycodes.h> (a
replication of wxWidgets key codes).
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::getPushedKey(enum mrpt::gui::mrptKeyModifier *) --> int
- getWxObject(...)
- getWxObject(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> capsule
Read-only access to the wxDialog object.
C++: mrpt::gui::CBaseGUIWindow::getWxObject() --> void *
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns false if the user has already closed the window.
C++: mrpt::gui::CBaseGUIWindow::isOpen() --> bool
- keyHit(...)
- keyHit(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns true if a key has been pushed, without blocking waiting for a
new key being pushed.
waitForKey, clearKeyHitFlag
C++: mrpt::gui::CBaseGUIWindow::keyHit() const --> bool
- notifyChildWindowDestruction(...)
- notifyChildWindowDestruction(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to set m_hwnd to NULL.
C++: mrpt::gui::CBaseGUIWindow::notifyChildWindowDestruction() --> void
- notifySemThreadReady(...)
- notifySemThreadReady(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to signal the semaphore that the wx window is
built and ready.
C++: mrpt::gui::CBaseGUIWindow::notifySemThreadReady() --> void
- waitForKey(...)
- waitForKey(*args, **kwargs)
Overloaded function.
1. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool) -> int
3. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Waits for any key to be pushed on the image or the console, and returns
the key code.
This method remove key strokes previous to its call, so it will always
wait. To get
the latest pushed key, see
If set to false, any push of shift, cmd,
control, etc... will make this method to return.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in mrptKeyCode (a replication
of wxWidgets key codes).
getPushedKey, Key codes in the enum mrptKeyCode
C++: mrpt::gui::CBaseGUIWindow::waitForKey(bool, enum mrpt::gui::mrptKeyModifier *) --> int
Methods inherited from mrpt.pymrpt.mrpt.system.CObservable:
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.system.CObservable, : mrpt.pymrpt.mrpt.system.CObservable) -> mrpt.pymrpt.mrpt.system.CObservable
C++: mrpt::system::CObservable::operator=(const class mrpt::system::CObservable &) --> class mrpt::system::CObservable &
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class CDisplayWindow3D(CBaseGUIWindow) |
| |
A graphical user interface (GUI) for efficiently rendering 3D scenes in
real-time.
This class always contains internally an instance of opengl::Scene,
which
the objects, viewports, etc. to be rendered.
Images can be grabbed automatically to disk for easy creation of videos.
See CDisplayWindow3D::grabImagesStart (and for creating videos,
mrpt::vision::CVideoFileWriter).
A short-cut for displaying 2D images (using the OpenGL rendering hardware)
is available
through . Internally, these methods call methods
in the "main" viewport of the window (see
Since the 3D rendering is performed in a detached thread, especial care
must be taken
when updating the 3D scene to be rendered. The process involves an
internal critical section
and it must always consist of these steps:
An alternative way of updating the scene is by creating, before locking the
3D window, a new object
of class Scene, then locking the window only for replacing the smart
pointer. This may be
advantageous is generating the 3D scene takes a long time, since while the
window
is locked it will not be responsive to the user input or window redraw.
It is safer against exceptions to use the auxiliary class
CDisplayWindow3DLocker.
Notice however that a copy of the smart pointer is made, so replacement of
the entire scene via `operator =` is not possible if using this method.
Instead, the content of the scene should be assigned using the `operator =`
of the **dereferenced** object as illustrated with
the `*ptrScene = *otherScene;` above.
The window can also display a set of 2D text messages overlapped to the 3D
scene. See CDisplayWindow3D::addTextMessage
For a list of supported events with the observer/observable pattern, see
the discussion in mrpt::gui::CBaseGUIWindow.
In addition to those events, this class introduces
mrpt::gui::mrptEvent3DWindowGrabImageFile
[CDisplayWindow3D mouse view navigation
cheatsheet](tutorial-3d-navigation-cheatsheet.html)
|
| |
- Method resolution order:
- CDisplayWindow3D
- CBaseGUIWindow
- mrpt.pymrpt.mrpt.system.CObservable
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, arg0: str) -> None
doc
3. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, arg0: str, arg1: int) -> None
doc
4. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, windowCaption: str, initialWindowWidth: int, initialWindowHeight: int) -> None
- addTextMessage(...)
- addTextMessage(*args, **kwargs)
Overloaded function.
1. addTextMessage(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x_frac: float, y_frac: float, text: str) -> None
2. addTextMessage(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x_frac: float, y_frac: float, text: str, unique_index: int) -> None
3. addTextMessage(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x_frac: float, y_frac: float, text: str, unique_index: int, fontParams: mrpt.pymrpt.mrpt.opengl.TFontParams) -> None
A shortcut for calling mrpt::opengl::Viewport::addTextMessage()
in the "main" viewport of the 3D scene.
clearTextMessages, mrpt::opengl::Viewport::addTextMessage()
C++: mrpt::gui::CDisplayWindow3D::addTextMessage(const double, const double, const std::string &, size_t, const struct mrpt::opengl::TFontParams &) --> void
- captureImagesStart(...)
- captureImagesStart(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Enables the grabbing of CImage objects from screenshots of the window.
getLastWindowImage
C++: mrpt::gui::CDisplayWindow3D::captureImagesStart() --> void
- captureImagesStop(...)
- captureImagesStop(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Stop image grabbing
captureImagesStart
C++: mrpt::gui::CDisplayWindow3D::captureImagesStop() --> void
- clearTextMessages(...)
- clearTextMessages(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Clear all text messages created with addTextMessage(). A shortcut for
calling mrpt::opengl::Viewport::clearTextMessages().
addTextMessage
C++: mrpt::gui::CDisplayWindow3D::clearTextMessages() --> void
- forceRepaint(...)
- forceRepaint(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Repaints the window. forceRepaint, repaint and updateWindow are all
aliases of the same method
C++: mrpt::gui::CDisplayWindow3D::forceRepaint() --> void
- get3DSceneAndLock(...)
- get3DSceneAndLock(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> mrpt.pymrpt.mrpt.opengl.Scene
Gets a reference to the smart shared pointer that holds the internal
scene (carefuly read introduction in gui::CDisplayWindow3D before use!)
This also locks the critical section for accessing the scene, thus the
window will not be repainted until it is unlocked.
It is safer to use mrpt::gui::CDisplayWindow3DLocker instead.
C++: mrpt::gui::CDisplayWindow3D::get3DSceneAndLock() --> class std::shared_ptr<class mrpt::opengl::Scene> &
- getCameraAzimuthDeg(...)
- getCameraAzimuthDeg(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> float
Get camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::getCameraAzimuthDeg() const --> float
- getCameraElevationDeg(...)
- getCameraElevationDeg(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> float
Get camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::getCameraElevationDeg() const --> float
- getCameraPointingToPoint(...)
- getCameraPointingToPoint(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x: float, y: float, z: float) -> None
Get camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::getCameraPointingToPoint(float &, float &, float &) const --> void
- getCameraZoom(...)
- getCameraZoom(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> float
Get camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::getCameraZoom() const --> float
- getDefaultViewport(...)
- getDefaultViewport(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> mrpt.pymrpt.mrpt.opengl.Viewport
A short cut for getting the "main" viewport of the scene object, it is
equivalent to:
C++: mrpt::gui::CDisplayWindow3D::getDefaultViewport() --> class std::shared_ptr<class mrpt::opengl::Viewport>
- getFOV(...)
- getFOV(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> float
Return the camera field of view (in degrees) (used for gluPerspective)
C++: mrpt::gui::CDisplayWindow3D::getFOV() const --> float
- getLastMousePosition(...)
- getLastMousePosition(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x: int, y: int) -> bool
Gets the last x,y pixel coordinates of the mouse.
False if the
window is closed.
getLastMousePositionRay
C++: mrpt::gui::CDisplayWindow3D::getLastMousePosition(int &, int &) const --> bool
- getLastMousePositionRay(...)
- getLastMousePositionRay(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, ray: mrpt::math::TLine3D) -> bool
Gets the 3D ray for the direction line of the pixel where the mouse
cursor is at.
False if the window is closed.
getLastMousePosition
C++: mrpt::gui::CDisplayWindow3D::getLastMousePositionRay(struct mrpt::math::TLine3D &) const --> bool
- getLastWindowImage(...)
- getLastWindowImage(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, out_img: mrpt.pymrpt.mrpt.img.CImage) -> bool
Retrieve the last captured image from the window.
You MUST CALL FIRST captureImagesStart to enable image grabbing.
false if there was no time yet for grabbing any image (then, the
output image is undefined).
captureImagesStart, getLastWindowImagePtr
C++: mrpt::gui::CDisplayWindow3D::getLastWindowImage(class mrpt::img::CImage &) const --> bool
- getLastWindowImagePtr(...)
- getLastWindowImagePtr(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> mrpt.pymrpt.mrpt.img.CImage
Retrieve the last captured image from the window, as a smart pointer.
This method is more efficient than getLastWindowImage since only a copy
of the pointer is performed, while
getLastWindowImage would copy the entire image.
You MUST CALL FIRST captureImagesStart to enable image grabbing.
If there was no time yet for grabbing any image, an empty smart
pointer will be returned.
captureImagesStart, getLastWindowImage
C++: mrpt::gui::CDisplayWindow3D::getLastWindowImagePtr() const --> class std::shared_ptr<class mrpt::img::CImage>
- getRenderingFPS(...)
- getRenderingFPS(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> float
Get the average Frames Per Second (FPS) value from the last 250
rendering events
C++: mrpt::gui::CDisplayWindow3D::getRenderingFPS() const --> double
- grabImageGetNextFile(...)
- grabImageGetNextFile(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> str
Increments by one the image counter and return the next image file name
(Users normally don't want to call this method).
grabImagesStart
C++: mrpt::gui::CDisplayWindow3D::grabImageGetNextFile() --> std::string
- grabImagesStart(...)
- grabImagesStart(*args, **kwargs)
Overloaded function.
1. grabImagesStart(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
2. grabImagesStart(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, grab_imgs_prefix: str) -> None
Start to save rendered images to disk.
Images will be saved independently as png files, depending on
the template path passed to this method. For example, the
path_prefix ``./video_`` will generate ``./video_000001.png``, etc.
If this feature is enabled, the window will emit events of the type
mrpt::gui::mrptEvent3DWindowGrabImageFile() which you can subscribe to.
grabImagesStop
C++: mrpt::gui::CDisplayWindow3D::grabImagesStart(const std::string &) --> void
- grabImagesStop(...)
- grabImagesStop(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Stops image grabbing started by grabImagesStart
grabImagesStart
C++: mrpt::gui::CDisplayWindow3D::grabImagesStop() --> void
- isCameraProjective(...)
- isCameraProjective(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> bool
Sets the camera as projective, or orthogonal
C++: mrpt::gui::CDisplayWindow3D::isCameraProjective() const --> bool
- isCapturingImgs(...)
- isCapturingImgs(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> bool
C++: mrpt::gui::CDisplayWindow3D::isCapturingImgs() const --> bool
- is_GL_context_created(...)
- is_GL_context_created(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> bool
C++: mrpt::gui::CDisplayWindow3D::is_GL_context_created() const --> bool
- repaint(...)
- repaint(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Repaints the window. forceRepaint, repaint and updateWindow are all
aliases of the same method
C++: mrpt::gui::CDisplayWindow3D::repaint() --> void
- resize(...)
- resize(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, width: int, height: int) -> None
Resizes the window, stretching the image to fit into the display area.
C++: mrpt::gui::CDisplayWindow3D::resize(unsigned int, unsigned int) --> void
- sendFunctionToRunOnGUIThread(...)
- sendFunctionToRunOnGUIThread(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, f: std::function<void ()>) -> None
C++: mrpt::gui::CDisplayWindow3D::sendFunctionToRunOnGUIThread(const class std::function<void (void)> &) --> void
- setCameraAzimuthDeg(...)
- setCameraAzimuthDeg(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, deg: float) -> None
Changes the camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::setCameraAzimuthDeg(float) --> void
- setCameraElevationDeg(...)
- setCameraElevationDeg(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, deg: float) -> None
Changes the camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::setCameraElevationDeg(float) --> void
- setCameraPointingToPoint(...)
- setCameraPointingToPoint(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x: float, y: float, z: float) -> None
Changes the camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::setCameraPointingToPoint(float, float, float) --> void
- setCameraProjective(...)
- setCameraProjective(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, isProjective: bool) -> None
Sets the camera as projective, or orthogonal.
C++: mrpt::gui::CDisplayWindow3D::setCameraProjective(bool) --> void
- setCameraZoom(...)
- setCameraZoom(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, zoom: float) -> None
Changes the camera parameters programmatically
C++: mrpt::gui::CDisplayWindow3D::setCameraZoom(float) --> void
- setCursorCross(...)
- setCursorCross(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, cursorIsCross: bool) -> None
Set cursor style to default (cursorIsCross=false) or to a cross
(cursorIsCross=true)
getLastMousePositionRay
C++: mrpt::gui::CDisplayWindow3D::setCursorCross(bool) --> void
- setFOV(...)
- setFOV(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, v: float) -> None
Changes the camera field of view (in degrees) (used for gluPerspective).
The window is not updated with this method, call "forceRepaint" to update
the 3D view.
C++: mrpt::gui::CDisplayWindow3D::setFOV(float) --> void
- setImageView(...)
- setImageView(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, img: mrpt.pymrpt.mrpt.img.CImage) -> None
Set the "main" viewport into "image view"-mode, where an image is
efficiently drawn (fitting the viewport area) using an OpenGL textured
quad.
Call this method with the new image to update the displayed image (but
recall to first lock the parent openglscene's critical section, then do
the update, then release the lock, and then issue a window repaint).
Internally, the texture is drawn using a mrpt::opengl::CTexturedPlane
The viewport can be reverted to behave like a normal viewport by
calling setNormalMode()
Viewport
This method already locks/unlocks the 3D scene of the window, so
the user must NOT call get3DSceneAndLock() / unlockAccess3DScene()
before/after calling it.
C++: mrpt::gui::CDisplayWindow3D::setImageView(const class mrpt::img::CImage &) --> void
- setMaxRange(...)
- setMaxRange(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, new_max: float) -> None
Changes the camera max clip range (z) (used for gluPerspective. The
window is not updated with this method, call "forceRepaint" to update the
3D view.
C++: mrpt::gui::CDisplayWindow3D::setMaxRange(float) --> void
- setMinRange(...)
- setMinRange(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, new_min: float) -> None
Changes the camera min clip range (z) (used for gluPerspective). The
window is not updated with this method, call "forceRepaint" to update the
3D view.
C++: mrpt::gui::CDisplayWindow3D::setMinRange(float) --> void
- setPos(...)
- setPos(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, x: int, y: int) -> None
Changes the position of the window on the screen.
C++: mrpt::gui::CDisplayWindow3D::setPos(int, int) --> void
- setWindowTitle(...)
- setWindowTitle(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, str: str) -> None
Changes the window title.
C++: mrpt::gui::CDisplayWindow3D::setWindowTitle(const std::string &) --> void
- unlockAccess3DScene(...)
- unlockAccess3DScene(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Unlocks the access to the internal 3D scene. It is safer to use
mrpt::gui::CDisplayWindow3DLocker instead.
Typically user will want to call forceRepaint after updating the scene.
C++: mrpt::gui::CDisplayWindow3D::unlockAccess3DScene() --> void
- updateTextMessage(...)
- updateTextMessage(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, unique_index: int, text: str) -> bool
Just updates the text of a given text message, without touching the
other parameters. A shortcut for
calling mrpt::opengl::Viewport::updateTextMessage()
false if given ID doesn't exist.
C++: mrpt::gui::CDisplayWindow3D::updateTextMessage(const unsigned long, const std::string &) --> bool
- updateWindow(...)
- updateWindow(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
Repaints the window. forceRepaint, repaint and updateWindow are all
aliases of the same method
C++: mrpt::gui::CDisplayWindow3D::updateWindow() --> void
- useCameraFromScene(...)
- useCameraFromScene(*args, **kwargs)
Overloaded function.
1. useCameraFromScene(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> None
2. useCameraFromScene(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, useIt: bool) -> None
If set to true (default = false), the mouse-based scene navigation will
be disabled and the camera position will be determined by the opengl
viewports in the 3D scene
C++: mrpt::gui::CDisplayWindow3D::useCameraFromScene(bool) --> void
- wait_for_GL_context(...)
- wait_for_GL_context(*args, **kwargs)
Overloaded function.
1. wait_for_GL_context(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D) -> bool
2. wait_for_GL_context(self: mrpt.pymrpt.mrpt.gui.CDisplayWindow3D, timeout_seconds: float) -> bool
C++: mrpt::gui::CDisplayWindow3D::wait_for_GL_context(const double) const --> bool
Static methods defined here:
- Create(...) from builtins.PyCapsule
- Create(*args, **kwargs)
Overloaded function.
1. Create(windowCaption: str) -> mrpt.pymrpt.mrpt.gui.CDisplayWindow3D
2. Create(windowCaption: str, initialWindowWidth: int) -> mrpt.pymrpt.mrpt.gui.CDisplayWindow3D
3. Create(windowCaption: str, initialWindowWidth: int, initialWindowHeight: int) -> mrpt.pymrpt.mrpt.gui.CDisplayWindow3D
Class factory returning a smart pointer, equivalent to
`std::make_shared<>(...)`
C++: mrpt::gui::CDisplayWindow3D::Create(const std::string &, unsigned int, unsigned int) --> class std::shared_ptr<class mrpt::gui::CDisplayWindow3D>
Methods inherited from CBaseGUIWindow:
- clearKeyHitFlag(...)
- clearKeyHitFlag(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Assure that "keyHit" will return false until the next pushed key.
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::clearKeyHitFlag() --> void
- getPushedKey(...)
- getPushedKey(*args, **kwargs)
Overloaded function.
1. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Returns the latest pushed key, or 0 if there is no new key stroke.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in <mrpt/gui/keycodes.h> (a
replication of wxWidgets key codes).
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::getPushedKey(enum mrpt::gui::mrptKeyModifier *) --> int
- getWxObject(...)
- getWxObject(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> capsule
Read-only access to the wxDialog object.
C++: mrpt::gui::CBaseGUIWindow::getWxObject() --> void *
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns false if the user has already closed the window.
C++: mrpt::gui::CBaseGUIWindow::isOpen() --> bool
- keyHit(...)
- keyHit(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns true if a key has been pushed, without blocking waiting for a
new key being pushed.
waitForKey, clearKeyHitFlag
C++: mrpt::gui::CBaseGUIWindow::keyHit() const --> bool
- notifyChildWindowDestruction(...)
- notifyChildWindowDestruction(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to set m_hwnd to NULL.
C++: mrpt::gui::CBaseGUIWindow::notifyChildWindowDestruction() --> void
- notifySemThreadReady(...)
- notifySemThreadReady(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to signal the semaphore that the wx window is
built and ready.
C++: mrpt::gui::CBaseGUIWindow::notifySemThreadReady() --> void
- waitForKey(...)
- waitForKey(*args, **kwargs)
Overloaded function.
1. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool) -> int
3. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Waits for any key to be pushed on the image or the console, and returns
the key code.
This method remove key strokes previous to its call, so it will always
wait. To get
the latest pushed key, see
If set to false, any push of shift, cmd,
control, etc... will make this method to return.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in mrptKeyCode (a replication
of wxWidgets key codes).
getPushedKey, Key codes in the enum mrptKeyCode
C++: mrpt::gui::CBaseGUIWindow::waitForKey(bool, enum mrpt::gui::mrptKeyModifier *) --> int
Methods inherited from mrpt.pymrpt.mrpt.system.CObservable:
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.system.CObservable, : mrpt.pymrpt.mrpt.system.CObservable) -> mrpt.pymrpt.mrpt.system.CObservable
C++: mrpt::system::CObservable::operator=(const class mrpt::system::CObservable &) --> class mrpt::system::CObservable &
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class CDisplayWindowGUI(mrpt.pymrpt.nanogui.Screen) |
| |
A window with powerful GUI capabilities, via the nanogui library.
You can add a background mrpt::opengl::Scene object rendered on the
background of the entire window by setting an object in field
`background_scene`, locking its mutex `background_scene_mtx`.
Refer to nanogui API docs or [MRPT examples](examples.html) for further usage
examples. A typical lifecycle of a GUI app with this class might look like:
Create managed subwindows with createManagedSubWindow(), with built-in
support for minimize and restore.
See demo video in: https://www.youtube.com/watch?v=QKMzdlZRW50
|
| |
- Method resolution order:
- CDisplayWindowGUI
- mrpt.pymrpt.nanogui.Screen
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, arg0: str) -> None
doc
3. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, arg0: str, arg1: int) -> None
doc
4. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, arg0: str, arg1: int, arg2: int) -> None
doc
5. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, caption: str, width: int, height: int, p: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI_Params) -> None
- addDropFilesCallback(...)
- addDropFilesCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, callback: std::function<bool (std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&)>) -> None
Handles drag-and drop events of files into the window.
This method can be safely called multiple times to register multiple
callbacks.
(New in MRPT 2.3.2)
C++: mrpt::gui::CDisplayWindowGUI::addDropFilesCallback(const class std::function<bool (const class std::vector<std::string > &)> &) --> void
- addKeyboardCallback(...)
- addKeyboardCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, callback: std::function<bool (int, int, int, int)>) -> None
Handles keyboard events.
This method can be safely called multiple times to register multiple
callbacks.
(New in MRPT 2.3.2)
C++: mrpt::gui::CDisplayWindowGUI::addKeyboardCallback(const class std::function<bool (int, int, int, int)> &) --> void
- addLoopCallback(...)
- addLoopCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, callback: std::function<void ()>) -> None
Every time the window is about to be repainted, an optional callback can
be called, if provided via this method. This method can be safely called
multiple times to register multiple callbacks.
(New in MRPT 2.3.2)
C++: mrpt::gui::CDisplayWindowGUI::addLoopCallback(const class std::function<void (void)> &) --> void
- camera(...)
- camera(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> mrpt.pymrpt.mrpt.gui.CGlCanvasBase
C++: mrpt::gui::CDisplayWindowGUI::camera() --> class mrpt::gui::CGlCanvasBase &
- createManagedSubWindow(...)
- createManagedSubWindow(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, title: str) -> mrpt.pymrpt.nanogui.Window
Creates and return a nanogui::Window, adds to it basic minimize/restore
tool buttons and add it to the list of handled subwindows so it gets
listed in the subwindows control UI.
User should set a layout manager, width, height, etc. in the returned
window as desired.
The returned object is owned by the nanogui system, you should NOT delete
it.
The first time this is called, an additional subWindow will be created
(default position:bottom left corner) to hold minimized windows.
You can access and modify this windows via getSubWindowsUI().
[New in MRPT 2.1.1]
C++: mrpt::gui::CDisplayWindowGUI::createManagedSubWindow(const std::string &) --> class nanogui::Window *
- drawContents(...)
- drawContents(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> None
@}
C++: mrpt::gui::CDisplayWindowGUI::drawContents() --> void
- dropFilesCallback(...)
- dropFilesCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> std::function<bool (std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&)>
In MRPT 2.3.2, replaced by dropFilesCallbacks()
C++: mrpt::gui::CDisplayWindowGUI::dropFilesCallback() const --> class std::function<bool (const class std::vector<std::string > &)>
- getSubWindowsUI(...)
- getSubWindowsUI(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> mrpt.pymrpt.nanogui.Window
C++: mrpt::gui::CDisplayWindowGUI::getSubWindowsUI() --> class nanogui::Window *
- getSubwindow(...)
- getSubwindow(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, index: int) -> mrpt.pymrpt.nanogui.Window
Direct (read-only) access to managed subwindows by 0-based index
(creation order).
createManagedSubWindow()
[New in MRPT 2.3.1]
C++: mrpt::gui::CDisplayWindowGUI::getSubwindow(size_t) const --> const class nanogui::Window *
- getSubwindowCount(...)
- getSubwindowCount(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> int
Get the number of managed subwindows.
createManagedSubWindow()
[New in MRPT 2.3.1]
C++: mrpt::gui::CDisplayWindowGUI::getSubwindowCount() const --> size_t
- keyboardCallback(...)
- keyboardCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> std::function<bool (int, int, int, int)>
In MRPT 2.3.2, replaced by keyboardCallbacks()
C++: mrpt::gui::CDisplayWindowGUI::keyboardCallback() const --> class std::function<bool (int, int, int, int)>
- loopCallback(...)
- loopCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> std::function<void ()>
In MRPT 2.3.2, replaced by loopCallbacks()
C++: mrpt::gui::CDisplayWindowGUI::loopCallback() const --> class std::function<void (void)>
- nanogui_screen(...)
- nanogui_screen(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> mrpt.pymrpt.nanogui.Screen
@{
C++: mrpt::gui::CDisplayWindowGUI::nanogui_screen() --> class nanogui::Screen *
- onIdleLoopTasks(...)
- onIdleLoopTasks(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI) -> None
C++: mrpt::gui::CDisplayWindowGUI::onIdleLoopTasks() --> void
- resize(...)
- resize(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, width: int, height: int) -> None
Resizes the window
C++: mrpt::gui::CDisplayWindowGUI::resize(unsigned int, unsigned int) --> void
- setDropFilesCallback(...)
- setDropFilesCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, callback: std::function<bool (std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&)>) -> None
This call replaces *all* existing drop file callbacks. See
addDropFilesCallback().
In MRPT 2.3.2, replaced by addDropFilesCallback()
C++: mrpt::gui::CDisplayWindowGUI::setDropFilesCallback(const class std::function<bool (const class std::vector<std::string > &)> &) --> void
- setIcon(...)
- setIcon(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, img: mrpt.pymrpt.mrpt.img.CImage) -> None
Sets the window icon, which must must either RGB or (preferred) RGBA
channels. You can read it from a .png or .ico file using
mrpt::img::CImage::loadFromFile().
The image will be resized as needed. Good sizes include 16x16, 32x32 and
48x48.
(New in MRPT 2.4.2)
C++: mrpt::gui::CDisplayWindowGUI::setIcon(const class mrpt::img::CImage &) --> void
- setIconFromData(...)
- setIconFromData(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, imgData: str, width: int, height: int, transparent: int) -> None
"GIMP header image formar (RGB)", with a transparent color.
(New in MRPT 2.4.2)
C++: mrpt::gui::CDisplayWindowGUI::setIconFromData(const char *, unsigned int, unsigned int, const unsigned char) --> void
- setKeyboardCallback(...)
- setKeyboardCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, callback: std::function<bool (int, int, int, int)>) -> None
This call replaces *all* existing keyboard callbacks. See
addKeyboardCallback().
In MRPT 2.3.2, replaced by addKeyboardCallback()
C++: mrpt::gui::CDisplayWindowGUI::setKeyboardCallback(const class std::function<bool (int, int, int, int)> &) --> void
- setLoopCallback(...)
- setLoopCallback(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, callback: std::function<void ()>) -> None
This call replaces *all* existing loop callbacks. See
addLoopCallback().
In MRPT 2.3.2, replaced by addLoopCallback()
C++: mrpt::gui::CDisplayWindowGUI::setLoopCallback(const class std::function<void (void)> &) --> void
- setPos(...)
- setPos(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, x: int, y: int) -> None
Changes the position of the window on the screen.
C++: mrpt::gui::CDisplayWindowGUI::setPos(int, int) --> void
- setWindowTitle(...)
- setWindowTitle(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, str: str) -> None
Changes the window title.
C++: mrpt::gui::CDisplayWindowGUI::setWindowTitle(const std::string &) --> void
- subwindowMinimize(...)
- subwindowMinimize(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, index: int) -> None
Minimize a subwindow.
[New in MRPT 2.3.1]
C++: mrpt::gui::CDisplayWindowGUI::subwindowMinimize(size_t) --> void
- subwindowRestore(...)
- subwindowRestore(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, index: int) -> None
Restore a minimized subwindow.
[New in MRPT 2.3.1]
C++: mrpt::gui::CDisplayWindowGUI::subwindowRestore(size_t) --> void
- subwindowSetFocused(...)
- subwindowSetFocused(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowGUI, index: int) -> None
Forces focus on a subwindow.
[New in MRPT 2.3.1]
C++: mrpt::gui::CDisplayWindowGUI::subwindowSetFocused(size_t) --> void
Data descriptors defined here:
- background_scene
Methods inherited from mrpt.pymrpt.nanogui.Screen:
- background(...)
- background(self: mrpt.pymrpt.nanogui.Screen) -> mrpt.pymrpt.nanogui.Color
Return the screen's background color
C++: nanogui::Screen::background() const --> const class nanogui::Color &
- caption(...)
- caption(self: mrpt.pymrpt.nanogui.Screen) -> str
Get the window title bar caption
C++: nanogui::Screen::caption() const --> const std::string &
- centerWindow(...)
- centerWindow(self: mrpt.pymrpt.nanogui.Screen, window: nanogui::Window) -> None
C++: nanogui::Screen::centerWindow(class nanogui::Window *) --> void
- charCallbackEvent(...)
- charCallbackEvent(self: mrpt.pymrpt.nanogui.Screen, codepoint: int) -> bool
C++: nanogui::Screen::charCallbackEvent(unsigned int) --> bool
- cursorPosCallbackEvent(...)
- cursorPosCallbackEvent(self: mrpt.pymrpt.nanogui.Screen, x: float, y: float) -> bool
C++: nanogui::Screen::cursorPosCallbackEvent(double, double) --> bool
- disposeWindow(...)
- disposeWindow(self: mrpt.pymrpt.nanogui.Screen, window: nanogui::Window) -> None
C++: nanogui::Screen::disposeWindow(class nanogui::Window *) --> void
- drawAll(...)
- drawAll(self: mrpt.pymrpt.nanogui.Screen) -> None
Draw the Screen contents
C++: nanogui::Screen::drawAll() --> void
- drawWidgets(...)
- drawWidgets(self: mrpt.pymrpt.nanogui.Screen) -> None
C++: nanogui::Screen::drawWidgets() --> void
- dropEvent(...)
- dropEvent(self: mrpt.pymrpt.nanogui.Screen, : List[str]) -> bool
Handle a file drop event
C++: nanogui::Screen::dropEvent(const class std::vector<std::string > &) --> bool
- glfwWindow(...)
- glfwWindow(self: mrpt.pymrpt.nanogui.Screen) -> mrpt.pymrpt.GLFWwindow
Return a pointer to the underlying GLFW window data structure
C++: nanogui::Screen::glfwWindow() --> struct GLFWwindow *
- initialize(...)
- initialize(self: mrpt.pymrpt.nanogui.Screen, window: mrpt.pymrpt.GLFWwindow, shutdownGLFWOnDestruct: bool) -> None
Initialize the
C++: nanogui::Screen::initialize(struct GLFWwindow *, bool) --> void
- keyCallbackEvent(...)
- keyCallbackEvent(self: mrpt.pymrpt.nanogui.Screen, key: int, scancode: int, action: int, mods: int) -> bool
C++: nanogui::Screen::keyCallbackEvent(int, int, int, int) --> bool
- keyboardCharacterEvent(...)
- keyboardCharacterEvent(self: mrpt.pymrpt.nanogui.Screen, codepoint: int) -> bool
Text input event handler: codepoint is native endian UTF-32 format
C++: nanogui::Screen::keyboardCharacterEvent(unsigned int) --> bool
- keyboardEvent(...)
- keyboardEvent(self: mrpt.pymrpt.nanogui.Screen, key: int, scancode: int, action: int, modifiers: int) -> bool
Default keyboard event handler
C++: nanogui::Screen::keyboardEvent(int, int, int, int) --> bool
- mouseButtonCallbackEvent(...)
- mouseButtonCallbackEvent(self: mrpt.pymrpt.nanogui.Screen, button: int, action: int, modifiers: int) -> bool
C++: nanogui::Screen::mouseButtonCallbackEvent(int, int, int) --> bool
- mouseModifiers(...)
- mouseModifiers(self: mrpt.pymrpt.nanogui.Screen) -> int
Returns the last mouse modifiers. Bitwise or of:
Shift=0x0001, Control=0x0002, Alt=0x0004, Super=0x0008
C++: nanogui::Screen::mouseModifiers() const --> int
- mouseState(...)
- mouseState(self: mrpt.pymrpt.nanogui.Screen) -> int
Returns the last mouse state (bitwise 1 << button)
C++: nanogui::Screen::mouseState() const --> int
- moveWindowToFront(...)
- moveWindowToFront(self: mrpt.pymrpt.nanogui.Screen, window: nanogui::Window) -> None
C++: nanogui::Screen::moveWindowToFront(class nanogui::Window *) --> void
- nvgContext(...)
- nvgContext(self: mrpt.pymrpt.nanogui.Screen) -> mrpt.pymrpt.NVGcontext
Return a pointer to the underlying nanoVG draw context
C++: nanogui::Screen::nvgContext() --> struct NVGcontext *
- performLayout(...)
- performLayout(*args, **kwargs)
Overloaded function.
1. performLayout(self: mrpt.pymrpt.nanogui.Screen, ctx: mrpt.pymrpt.NVGcontext) -> None
2. performLayout(self: mrpt.pymrpt.nanogui.Screen) -> None
Compute the layout of all widgets
C++: nanogui::Screen::performLayout() --> void
- pixelRatio(...)
- pixelRatio(self: mrpt.pymrpt.nanogui.Screen) -> float
Return the ratio between pixel and device coordinates (e.g. >= 2 on Mac
Retina displays)
C++: nanogui::Screen::pixelRatio() const --> float
- resizeCallback(...)
- resizeCallback(self: mrpt.pymrpt.nanogui.Screen) -> std::function<void (Eigen::Matrix<int, 2, 1, 0, 2, 1>)>
Set the resize callback
C++: nanogui::Screen::resizeCallback() const --> class std::function<void (class Eigen::Matrix<int, 2, 1, 0>)>
- resizeCallbackEvent(...)
- resizeCallbackEvent(self: mrpt.pymrpt.nanogui.Screen, width: int, height: int) -> bool
C++: nanogui::Screen::resizeCallbackEvent(int, int) --> bool
- scrollCallbackEvent(...)
- scrollCallbackEvent(self: mrpt.pymrpt.nanogui.Screen, x: float, y: float) -> bool
C++: nanogui::Screen::scrollCallbackEvent(double, double) --> bool
- setBackground(...)
- setBackground(self: mrpt.pymrpt.nanogui.Screen, background: mrpt.pymrpt.nanogui.Color) -> None
Set the screen's background color
C++: nanogui::Screen::setBackground(const class nanogui::Color &) --> void
- setCaption(...)
- setCaption(self: mrpt.pymrpt.nanogui.Screen, caption: str) -> None
Set the window title bar caption
C++: nanogui::Screen::setCaption(const std::string &) --> void
- setResizeCallback(...)
- setResizeCallback(self: mrpt.pymrpt.nanogui.Screen, callback: std::function<void (Eigen::Matrix<int, 2, 1, 0, 2, 1>)>) -> None
C++: nanogui::Screen::setResizeCallback(const class std::function<void (class Eigen::Matrix<int, 2, 1, 0>)> &) --> void
- setShutdownGLFWOnDestruct(...)
- setShutdownGLFWOnDestruct(self: mrpt.pymrpt.nanogui.Screen, v: bool) -> None
C++: nanogui::Screen::setShutdownGLFWOnDestruct(bool) --> void
- setVisible(...)
- setVisible(self: mrpt.pymrpt.nanogui.Screen, visible: bool) -> None
Set the top-level window visibility (no effect on full-screen windows)
C++: nanogui::Screen::setVisible(bool) --> void
- shutdownGLFWOnDestruct(...)
- shutdownGLFWOnDestruct(self: mrpt.pymrpt.nanogui.Screen) -> bool
C++: nanogui::Screen::shutdownGLFWOnDestruct() --> bool
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class CDisplayWindowPlots(CBaseGUIWindow) |
| |
Create a GUI window and display plots with MATLAB-like interfaces and
commands.
For a list of supported events with the observer/observable pattern, see the
discussion in mrpt::gui::CBaseGUIWindow.
See CDisplayWindowPlots::plot
|
| |
- Method resolution order:
- CDisplayWindowPlots
- CBaseGUIWindow
- mrpt.pymrpt.mrpt.system.CObservable
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, arg0: str) -> None
doc
3. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, arg0: str, arg1: int) -> None
doc
4. __init__(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, windowCaption: str, initialWidth: int, initialHeight: int) -> None
- addPopupMenuEntry(...)
- addPopupMenuEntry(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, label: str, menuID: int) -> None
Disables keeping all the graphs (this is the default behavior).
The text that appears in the new popup menu item.
Any positive number (0,1,..). Used to tell which menu was
selected in the user callback.
setMenuCallback
C++: mrpt::gui::CDisplayWindowPlots::addPopupMenuEntry(const std::string &, int) --> void
- axis(...)
- axis(*args, **kwargs)
Overloaded function.
1. axis(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, x_min: float, x_max: float, y_min: float, y_max: float) -> None
2. axis(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, x_min: float, x_max: float, y_min: float, y_max: float, aspectRatioFix: bool) -> None
Set the view area according to the passed coordinated.
C++: mrpt::gui::CDisplayWindowPlots::axis(float, float, float, float, bool) --> void
- axis_equal(...)
- axis_equal(*args, **kwargs)
Overloaded function.
1. axis_equal(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
2. axis_equal(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, enable: bool) -> None
Enable/disable the fixed X/Y aspect ratio fix feature
(default=disabled).
C++: mrpt::gui::CDisplayWindowPlots::axis_equal(bool) --> void
- axis_fit(...)
- axis_fit(*args, **kwargs)
Overloaded function.
1. axis_fit(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
2. axis_fit(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, aspectRatioFix: bool) -> None
Fix automatically the view area according to existing graphs.
C++: mrpt::gui::CDisplayWindowPlots::axis_fit(bool) --> void
- clear(...)
- clear(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
Remove all plot objects in the display.
plot
C++: mrpt::gui::CDisplayWindowPlots::clear() --> void
- clf(...)
- clf(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
Remove all plot objects in the display (clear and clf do exactly the
same).
plot, hold_on, hold_off
C++: mrpt::gui::CDisplayWindowPlots::clf() --> void
- enableMousePanZoom(...)
- enableMousePanZoom(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, enabled: bool) -> None
Enable/disable the feature of pan/zoom with the mouse (default=enabled)
C++: mrpt::gui::CDisplayWindowPlots::enableMousePanZoom(bool) --> void
- getLastMousePosition(...)
- getLastMousePosition(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, x: int, y: int) -> bool
Gets the last x,y pixel coordinates of the mouse.
False if the
window is closed.
C++: mrpt::gui::CDisplayWindowPlots::getLastMousePosition(int &, int &) const --> bool
- hold_off(...)
- hold_off(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
Disables keeping all the graphs (this is the default behavior).
hold_on, plot
C++: mrpt::gui::CDisplayWindowPlots::hold_off() --> void
- hold_on(...)
- hold_on(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots) -> None
Enables keeping all the graphs, instead of overwriting them.
hold_off, plot
C++: mrpt::gui::CDisplayWindowPlots::hold_on() --> void
- image(...)
- image(*args, **kwargs)
Overloaded function.
1. image(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, img: mrpt.pymrpt.mrpt.img.CImage, x_left: float, y_bottom: float, x_width: float, y_height: float) -> None
2. image(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, img: mrpt.pymrpt.mrpt.img.CImage, x_left: float, y_bottom: float, x_width: float, y_height: float, plotName: str) -> None
Adds a bitmap image layer.
Each call to this function creates a new layer, unless the plot name
coincides with an already existing plot: in this case the new values are
used to update this existing layer (this also applies to using the
default plot name).
axis, axis_equal, axis_fit, hold_on, hold_off
C++: mrpt::gui::CDisplayWindowPlots::image(const class mrpt::img::CImage &, float, float, float, float, const std::string &) --> void
- resize(...)
- resize(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, width: int, height: int) -> None
Resizes the window, stretching the image to fit into the display area.
C++: mrpt::gui::CDisplayWindowPlots::resize(unsigned int, unsigned int) --> void
- setCursorCross(...)
- setCursorCross(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, cursorIsCross: bool) -> None
Set cursor style to default (cursorIsCross=false) or to a cross
(cursorIsCross=true)
C++: mrpt::gui::CDisplayWindowPlots::setCursorCross(bool) --> void
- setPos(...)
- setPos(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, x: int, y: int) -> None
Changes the position of the window on the screen.
C++: mrpt::gui::CDisplayWindowPlots::setPos(int, int) --> void
- setWindowTitle(...)
- setWindowTitle(self: mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots, str: str) -> None
Changes the window title text.
C++: mrpt::gui::CDisplayWindowPlots::setWindowTitle(const std::string &) --> void
Static methods defined here:
- Create(...) from builtins.PyCapsule
- Create(*args, **kwargs)
Overloaded function.
1. Create(windowCaption: str) -> mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots
2. Create(windowCaption: str, initialWindowWidth: int) -> mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots
3. Create(windowCaption: str, initialWindowWidth: int, initialWindowHeight: int) -> mrpt.pymrpt.mrpt.gui.CDisplayWindowPlots
Class factory returning a smart pointer, equivalent to
`std::make_shared<>(...)`
C++: mrpt::gui::CDisplayWindowPlots::Create(const std::string &, unsigned int, unsigned int) --> class std::shared_ptr<class mrpt::gui::CDisplayWindowPlots>
Methods inherited from CBaseGUIWindow:
- clearKeyHitFlag(...)
- clearKeyHitFlag(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Assure that "keyHit" will return false until the next pushed key.
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::clearKeyHitFlag() --> void
- getPushedKey(...)
- getPushedKey(*args, **kwargs)
Overloaded function.
1. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. getPushedKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Returns the latest pushed key, or 0 if there is no new key stroke.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in <mrpt/gui/keycodes.h> (a
replication of wxWidgets key codes).
keyHit, waitForKey
C++: mrpt::gui::CBaseGUIWindow::getPushedKey(enum mrpt::gui::mrptKeyModifier *) --> int
- getWxObject(...)
- getWxObject(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> capsule
Read-only access to the wxDialog object.
C++: mrpt::gui::CBaseGUIWindow::getWxObject() --> void *
- isOpen(...)
- isOpen(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns false if the user has already closed the window.
C++: mrpt::gui::CBaseGUIWindow::isOpen() --> bool
- keyHit(...)
- keyHit(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> bool
Returns true if a key has been pushed, without blocking waiting for a
new key being pushed.
waitForKey, clearKeyHitFlag
C++: mrpt::gui::CBaseGUIWindow::keyHit() const --> bool
- notifyChildWindowDestruction(...)
- notifyChildWindowDestruction(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to set m_hwnd to NULL.
C++: mrpt::gui::CBaseGUIWindow::notifyChildWindowDestruction() --> void
- notifySemThreadReady(...)
- notifySemThreadReady(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
Called by wx main thread to signal the semaphore that the wx window is
built and ready.
C++: mrpt::gui::CBaseGUIWindow::notifySemThreadReady() --> void
- waitForKey(...)
- waitForKey(*args, **kwargs)
Overloaded function.
1. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> int
2. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool) -> int
3. waitForKey(self: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, ignoreControlKeys: bool, out_pushModifier: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
Waits for any key to be pushed on the image or the console, and returns
the key code.
This method remove key strokes previous to its call, so it will always
wait. To get
the latest pushed key, see
If set to false, any push of shift, cmd,
control, etc... will make this method to return.
If set to !=nullptr, the modifiers of the key
stroke will be saved here.
The virtual key code, as defined in mrptKeyCode (a replication
of wxWidgets key codes).
getPushedKey, Key codes in the enum mrptKeyCode
C++: mrpt::gui::CBaseGUIWindow::waitForKey(bool, enum mrpt::gui::mrptKeyModifier *) --> int
Methods inherited from mrpt.pymrpt.mrpt.system.CObservable:
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.system.CObservable, : mrpt.pymrpt.mrpt.system.CObservable) -> mrpt.pymrpt.mrpt.system.CObservable
C++: mrpt::system::CObservable::operator=(const class mrpt::system::CObservable &) --> class mrpt::system::CObservable &
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class CGlCanvasBase(pybind11_builtins.pybind11_object) |
| |
This base class implements a working with opengl::Camera and a OpenGL
canvas, and it's used in gui::CWxGLCanvasBase and gui::CQtGlCanvasBase.
|
| |
- Method resolution order:
- CGlCanvasBase
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- OnUserManuallyMovesCamera(...)
- OnUserManuallyMovesCamera(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, new_cameraPointingX: float, new_cameraPointingY: float, new_cameraPointingZ: float, new_cameraZoomDistance: float, new_cameraElevationDeg: float, new_cameraAzimuthDeg: float) -> None
Overload this method to limit the capabilities of the user to move the
camera using the mouse.
For all these variables:
- cameraPointingX
- cameraPointingY
- cameraPointingZ
- cameraZoomDistance
- cameraElevationDeg
- cameraAzimuthDeg
A "new_NAME" variable will be passed with the temptative new
value after the user action.
The default behavior should be to copy all the new variables
to the variables listed above
but in the middle any find of user-defined filter can be
implemented.
C++: mrpt::gui::CGlCanvasBase::OnUserManuallyMovesCamera(float, float, float, float, float, float) --> void
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> None
2. __init__(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, arg0: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> None
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, : mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt.pymrpt.mrpt.gui.CGlCanvasBase
C++: mrpt::gui::CGlCanvasBase::operator=(const class mrpt::gui::CGlCanvasBase &) --> class mrpt::gui::CGlCanvasBase &
- cameraFOV(...)
- cameraFOV(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
C++: mrpt::gui::CGlCanvasBase::cameraFOV() const --> float
- cameraParams(...)
- cameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt::gui::CGlCanvasBase::CamaraParams
Returns a copy of CamaraParams
See also getRefCameraParams(), setCameraParams(const CamaraParams &)
C++: mrpt::gui::CGlCanvasBase::cameraParams() const --> struct mrpt::gui::CGlCanvasBase::CamaraParams
- getAzimuthDegrees(...)
- getAzimuthDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns a azimuth degrees
See also setAzimuthDegrees(float)
C++: mrpt::gui::CGlCanvasBase::getAzimuthDegrees() const --> float
- getCameraPointingX(...)
- getCameraPointingX(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns the x pointing of the camera
See also setCameraPointing(float, float, float)
C++: mrpt::gui::CGlCanvasBase::getCameraPointingX() const --> float
- getCameraPointingY(...)
- getCameraPointingY(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns the y pointing of the camera
See also setCameraPointing(float, float, float)
C++: mrpt::gui::CGlCanvasBase::getCameraPointingY() const --> float
- getCameraPointingZ(...)
- getCameraPointingZ(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns the z pointing of the camera
See also setCameraPointing(float, float, float)
C++: mrpt::gui::CGlCanvasBase::getCameraPointingZ() const --> float
- getElevationDegrees(...)
- getElevationDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns a elevation degrees
See also setElevationDegrees(float)
C++: mrpt::gui::CGlCanvasBase::getElevationDegrees() const --> float
- getLastMousePosition(...)
- getLastMousePosition(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, x: int, y: int) -> None
C++: mrpt::gui::CGlCanvasBase::getLastMousePosition(int &, int &) const --> void
- getOpenGLSceneRef(...)
- getOpenGLSceneRef(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt.pymrpt.mrpt.opengl.Scene
At constructor an empty scene is created. The object is freed at GL
canvas destructor.
This function returns a smart pointer to the opengl scene
getOpenGLSceneRef
C++: mrpt::gui::CGlCanvasBase::getOpenGLSceneRef() --> class std::shared_ptr<class mrpt::opengl::Scene> &
- getRefCameraParams(...)
- getRefCameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt::gui::CGlCanvasBase::CamaraParams
Returns a reference to CamaraParams
See also cameraParams(), setCameraParams(const CamaraParams &)
C++: mrpt::gui::CGlCanvasBase::getRefCameraParams() const --> const struct mrpt::gui::CGlCanvasBase::CamaraParams &
- getUseCameraFromScene(...)
- getUseCameraFromScene(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> bool
See also void setUseCameraFromScene(bool)
C++: mrpt::gui::CGlCanvasBase::getUseCameraFromScene() const --> bool
- getZoomDistance(...)
- getZoomDistance(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns a zoom
See also setZoomDistance(float)
C++: mrpt::gui::CGlCanvasBase::getZoomDistance() const --> float
- isCameraProjective(...)
- isCameraProjective(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> bool
C++: mrpt::gui::CGlCanvasBase::isCameraProjective() const --> bool
- resizeViewport(...)
- resizeViewport(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, w: int, h: int) -> None
Calls the glViewport function
C++: mrpt::gui::CGlCanvasBase::resizeViewport(int, int) --> void
- setAzimuthDegrees(...)
- setAzimuthDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, ang: float) -> None
Saves the degrees of the azimuth camera
See also getAzimuthDegrees()
C++: mrpt::gui::CGlCanvasBase::setAzimuthDegrees(float) --> void
- setCameraFOV(...)
- setCameraFOV(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, FOV: float) -> None
C++: mrpt::gui::CGlCanvasBase::setCameraFOV(float) --> void
- setCameraParams(...)
- setCameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams) -> None
Sets the CamaraParams
See also cameraParams(), getRefCameraParams()
C++: mrpt::gui::CGlCanvasBase::setCameraParams(const struct mrpt::gui::CGlCanvasBase::CamaraParams &) --> void
- setCameraPointing(...)
- setCameraPointing(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, pointX: float, pointY: float, pointZ: float) -> None
Saves the pointing of the camera
See also getCameraPointingX(), getCameraPointingY(), getCameraPointingZ()
C++: mrpt::gui::CGlCanvasBase::setCameraPointing(float, float, float) --> void
- setCameraProjective(...)
- setCameraProjective(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, is: bool) -> None
C++: mrpt::gui::CGlCanvasBase::setCameraProjective(bool) --> void
- setElevationDegrees(...)
- setElevationDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, ang: float) -> None
Saves the degrees of the elevation camera
See also getElevationDegrees()
C++: mrpt::gui::CGlCanvasBase::setElevationDegrees(float) --> void
- setMaximumZoom(...)
- setMaximumZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, zoom: float) -> None
Sets the maximum of the zoom
See also setMinimumZoom(float)
C++: mrpt::gui::CGlCanvasBase::setMaximumZoom(float) --> void
- setMinimumZoom(...)
- setMinimumZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, zoom: float) -> None
Sets the minimum of the zoom
See also setMaximumZoom(float)
C++: mrpt::gui::CGlCanvasBase::setMinimumZoom(float) --> void
- setMouseClicked(...)
- setMouseClicked(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, is: bool) -> None
Sets the property mouseClicked
By default, this property is false.
See also setMousePos(int, int)
C++: mrpt::gui::CGlCanvasBase::setMouseClicked(bool) --> void
- setMousePos(...)
- setMousePos(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, x: int, y: int) -> None
Saves the click position of the mouse
See also setMouseClicked(bool)
C++: mrpt::gui::CGlCanvasBase::setMousePos(int, int) --> void
- setOpenGLSceneRef(...)
- setOpenGLSceneRef(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, scene: mrpt.pymrpt.mrpt.opengl.Scene) -> None
C++: mrpt::gui::CGlCanvasBase::setOpenGLSceneRef(class std::shared_ptr<class mrpt::opengl::Scene>) --> void
- setUseCameraFromScene(...)
- setUseCameraFromScene(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, is: bool) -> None
If set to true (default=false), the cameraPointingX,... parameters are
ignored and the camera stored in the 3D scene is used instead.
See also void bool getUseCameraFromScene()
C++: mrpt::gui::CGlCanvasBase::setUseCameraFromScene(bool) --> void
- setZoomDistance(...)
- setZoomDistance(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, zoom: float) -> None
Saves camera zooming
See also getZoomDistance()
C++: mrpt::gui::CGlCanvasBase::setZoomDistance(float) --> void
- updateCameraParams(...)
- updateCameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, cam: mrpt.pymrpt.mrpt.opengl.CCamera) -> mrpt.pymrpt.mrpt.opengl.CCamera
This function gets a reference to mrpt::opengl::CCamera and
updates the camera parameters(pointing, zoom, azimuth, elevation,
IsProjective, FOV)
C++: mrpt::gui::CGlCanvasBase::updateCameraParams(class mrpt::opengl::CCamera &) const --> class mrpt::opengl::CCamera &
- updateLastPos(...)
- updateLastPos(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, x: int, y: int) -> None
Sets the last mouse position
C++: mrpt::gui::CGlCanvasBase::updateLastPos(int, int) --> void
- updateOrbitCamera(...)
- updateOrbitCamera(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the elevation and azimuth.
See also getElevationDegrees(), getAzimuthDegrees()
C++: mrpt::gui::CGlCanvasBase::updateOrbitCamera(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
- updatePan(...)
- updatePan(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the pointing of the camera.
See also getCameraPointingX(), getCameraPointingY(),
getCameraPointingZ()
C++: mrpt::gui::CGlCanvasBase::updatePan(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
- updateRotate(...)
- updateRotate(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the elevation and azimuth.
See also getElevationDegrees(), getAzimuthDegrees()
C++: mrpt::gui::CGlCanvasBase::updateRotate(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
- updateZoom(...)
- updateZoom(*args, **kwargs)
Overloaded function.
1. updateZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the zoom of the CameraParams.
See also updateZoom(CamaraParams &, float)
C++: mrpt::gui::CGlCanvasBase::updateZoom(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
2. updateZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, delta: float) -> None
This function for the wheel event
It gets a reference to CamaraParams, delta
and updates the zoom of the CameraParams.
See also updateZoom(CamaraParams &, int, int)
C++: mrpt::gui::CGlCanvasBase::updateZoom(struct mrpt::gui::CGlCanvasBase::CamaraParams &, float) const --> void
Data and other attributes defined here:
- CamaraParams = <class 'mrpt.pymrpt.mrpt.gui.CGlCanvasBase.CamaraParams'>
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class CGlCanvasBaseHeadless(CGlCanvasBase) |
| |
A headless dummy implementation of CGlCanvasBase: can be used to keep track
of user UI mouse events and update the camera parameters, with actual
rendering being delegated to someone else.
|
| |
- Method resolution order:
- CGlCanvasBaseHeadless
- CGlCanvasBase
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless) -> None
2. __init__(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless, arg0: mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless) -> None
3. __init__(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless, arg0: mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless) -> None
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless, : mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless) -> mrpt.pymrpt.mrpt.gui.CGlCanvasBaseHeadless
C++: mrpt::gui::CGlCanvasBaseHeadless::operator=(const class mrpt::gui::CGlCanvasBaseHeadless &) --> class mrpt::gui::CGlCanvasBaseHeadless &
Methods inherited from CGlCanvasBase:
- OnUserManuallyMovesCamera(...)
- OnUserManuallyMovesCamera(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, new_cameraPointingX: float, new_cameraPointingY: float, new_cameraPointingZ: float, new_cameraZoomDistance: float, new_cameraElevationDeg: float, new_cameraAzimuthDeg: float) -> None
Overload this method to limit the capabilities of the user to move the
camera using the mouse.
For all these variables:
- cameraPointingX
- cameraPointingY
- cameraPointingZ
- cameraZoomDistance
- cameraElevationDeg
- cameraAzimuthDeg
A "new_NAME" variable will be passed with the temptative new
value after the user action.
The default behavior should be to copy all the new variables
to the variables listed above
but in the middle any find of user-defined filter can be
implemented.
C++: mrpt::gui::CGlCanvasBase::OnUserManuallyMovesCamera(float, float, float, float, float, float) --> void
- cameraFOV(...)
- cameraFOV(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
C++: mrpt::gui::CGlCanvasBase::cameraFOV() const --> float
- cameraParams(...)
- cameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt::gui::CGlCanvasBase::CamaraParams
Returns a copy of CamaraParams
See also getRefCameraParams(), setCameraParams(const CamaraParams &)
C++: mrpt::gui::CGlCanvasBase::cameraParams() const --> struct mrpt::gui::CGlCanvasBase::CamaraParams
- getAzimuthDegrees(...)
- getAzimuthDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns a azimuth degrees
See also setAzimuthDegrees(float)
C++: mrpt::gui::CGlCanvasBase::getAzimuthDegrees() const --> float
- getCameraPointingX(...)
- getCameraPointingX(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns the x pointing of the camera
See also setCameraPointing(float, float, float)
C++: mrpt::gui::CGlCanvasBase::getCameraPointingX() const --> float
- getCameraPointingY(...)
- getCameraPointingY(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns the y pointing of the camera
See also setCameraPointing(float, float, float)
C++: mrpt::gui::CGlCanvasBase::getCameraPointingY() const --> float
- getCameraPointingZ(...)
- getCameraPointingZ(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns the z pointing of the camera
See also setCameraPointing(float, float, float)
C++: mrpt::gui::CGlCanvasBase::getCameraPointingZ() const --> float
- getElevationDegrees(...)
- getElevationDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns a elevation degrees
See also setElevationDegrees(float)
C++: mrpt::gui::CGlCanvasBase::getElevationDegrees() const --> float
- getLastMousePosition(...)
- getLastMousePosition(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, x: int, y: int) -> None
C++: mrpt::gui::CGlCanvasBase::getLastMousePosition(int &, int &) const --> void
- getOpenGLSceneRef(...)
- getOpenGLSceneRef(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt.pymrpt.mrpt.opengl.Scene
At constructor an empty scene is created. The object is freed at GL
canvas destructor.
This function returns a smart pointer to the opengl scene
getOpenGLSceneRef
C++: mrpt::gui::CGlCanvasBase::getOpenGLSceneRef() --> class std::shared_ptr<class mrpt::opengl::Scene> &
- getRefCameraParams(...)
- getRefCameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> mrpt::gui::CGlCanvasBase::CamaraParams
Returns a reference to CamaraParams
See also cameraParams(), setCameraParams(const CamaraParams &)
C++: mrpt::gui::CGlCanvasBase::getRefCameraParams() const --> const struct mrpt::gui::CGlCanvasBase::CamaraParams &
- getUseCameraFromScene(...)
- getUseCameraFromScene(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> bool
See also void setUseCameraFromScene(bool)
C++: mrpt::gui::CGlCanvasBase::getUseCameraFromScene() const --> bool
- getZoomDistance(...)
- getZoomDistance(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> float
Returns a zoom
See also setZoomDistance(float)
C++: mrpt::gui::CGlCanvasBase::getZoomDistance() const --> float
- isCameraProjective(...)
- isCameraProjective(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase) -> bool
C++: mrpt::gui::CGlCanvasBase::isCameraProjective() const --> bool
- resizeViewport(...)
- resizeViewport(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, w: int, h: int) -> None
Calls the glViewport function
C++: mrpt::gui::CGlCanvasBase::resizeViewport(int, int) --> void
- setAzimuthDegrees(...)
- setAzimuthDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, ang: float) -> None
Saves the degrees of the azimuth camera
See also getAzimuthDegrees()
C++: mrpt::gui::CGlCanvasBase::setAzimuthDegrees(float) --> void
- setCameraFOV(...)
- setCameraFOV(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, FOV: float) -> None
C++: mrpt::gui::CGlCanvasBase::setCameraFOV(float) --> void
- setCameraParams(...)
- setCameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams) -> None
Sets the CamaraParams
See also cameraParams(), getRefCameraParams()
C++: mrpt::gui::CGlCanvasBase::setCameraParams(const struct mrpt::gui::CGlCanvasBase::CamaraParams &) --> void
- setCameraPointing(...)
- setCameraPointing(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, pointX: float, pointY: float, pointZ: float) -> None
Saves the pointing of the camera
See also getCameraPointingX(), getCameraPointingY(), getCameraPointingZ()
C++: mrpt::gui::CGlCanvasBase::setCameraPointing(float, float, float) --> void
- setCameraProjective(...)
- setCameraProjective(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, is: bool) -> None
C++: mrpt::gui::CGlCanvasBase::setCameraProjective(bool) --> void
- setElevationDegrees(...)
- setElevationDegrees(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, ang: float) -> None
Saves the degrees of the elevation camera
See also getElevationDegrees()
C++: mrpt::gui::CGlCanvasBase::setElevationDegrees(float) --> void
- setMaximumZoom(...)
- setMaximumZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, zoom: float) -> None
Sets the maximum of the zoom
See also setMinimumZoom(float)
C++: mrpt::gui::CGlCanvasBase::setMaximumZoom(float) --> void
- setMinimumZoom(...)
- setMinimumZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, zoom: float) -> None
Sets the minimum of the zoom
See also setMaximumZoom(float)
C++: mrpt::gui::CGlCanvasBase::setMinimumZoom(float) --> void
- setMouseClicked(...)
- setMouseClicked(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, is: bool) -> None
Sets the property mouseClicked
By default, this property is false.
See also setMousePos(int, int)
C++: mrpt::gui::CGlCanvasBase::setMouseClicked(bool) --> void
- setMousePos(...)
- setMousePos(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, x: int, y: int) -> None
Saves the click position of the mouse
See also setMouseClicked(bool)
C++: mrpt::gui::CGlCanvasBase::setMousePos(int, int) --> void
- setOpenGLSceneRef(...)
- setOpenGLSceneRef(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, scene: mrpt.pymrpt.mrpt.opengl.Scene) -> None
C++: mrpt::gui::CGlCanvasBase::setOpenGLSceneRef(class std::shared_ptr<class mrpt::opengl::Scene>) --> void
- setUseCameraFromScene(...)
- setUseCameraFromScene(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, is: bool) -> None
If set to true (default=false), the cameraPointingX,... parameters are
ignored and the camera stored in the 3D scene is used instead.
See also void bool getUseCameraFromScene()
C++: mrpt::gui::CGlCanvasBase::setUseCameraFromScene(bool) --> void
- setZoomDistance(...)
- setZoomDistance(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, zoom: float) -> None
Saves camera zooming
See also getZoomDistance()
C++: mrpt::gui::CGlCanvasBase::setZoomDistance(float) --> void
- updateCameraParams(...)
- updateCameraParams(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, cam: mrpt.pymrpt.mrpt.opengl.CCamera) -> mrpt.pymrpt.mrpt.opengl.CCamera
This function gets a reference to mrpt::opengl::CCamera and
updates the camera parameters(pointing, zoom, azimuth, elevation,
IsProjective, FOV)
C++: mrpt::gui::CGlCanvasBase::updateCameraParams(class mrpt::opengl::CCamera &) const --> class mrpt::opengl::CCamera &
- updateLastPos(...)
- updateLastPos(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, x: int, y: int) -> None
Sets the last mouse position
C++: mrpt::gui::CGlCanvasBase::updateLastPos(int, int) --> void
- updateOrbitCamera(...)
- updateOrbitCamera(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the elevation and azimuth.
See also getElevationDegrees(), getAzimuthDegrees()
C++: mrpt::gui::CGlCanvasBase::updateOrbitCamera(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
- updatePan(...)
- updatePan(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the pointing of the camera.
See also getCameraPointingX(), getCameraPointingY(),
getCameraPointingZ()
C++: mrpt::gui::CGlCanvasBase::updatePan(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
- updateRotate(...)
- updateRotate(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the elevation and azimuth.
See also getElevationDegrees(), getAzimuthDegrees()
C++: mrpt::gui::CGlCanvasBase::updateRotate(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
- updateZoom(...)
- updateZoom(*args, **kwargs)
Overloaded function.
1. updateZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, x: int, y: int) -> None
This function for the mouse event
It gets a reference to CamaraParams, x, y
and updates the zoom of the CameraParams.
See also updateZoom(CamaraParams &, float)
C++: mrpt::gui::CGlCanvasBase::updateZoom(struct mrpt::gui::CGlCanvasBase::CamaraParams &, int, int) const --> void
2. updateZoom(self: mrpt.pymrpt.mrpt.gui.CGlCanvasBase, params: mrpt::gui::CGlCanvasBase::CamaraParams, delta: float) -> None
This function for the wheel event
It gets a reference to CamaraParams, delta
and updates the zoom of the CameraParams.
See also updateZoom(CamaraParams &, int, int)
C++: mrpt::gui::CGlCanvasBase::updateZoom(struct mrpt::gui::CGlCanvasBase::CamaraParams &, float) const --> void
Data and other attributes inherited from CGlCanvasBase:
- CamaraParams = <class 'mrpt.pymrpt.mrpt.gui.CGlCanvasBase.CamaraParams'>
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class mrptEventWindowClosed(mrpt.pymrpt.mrpt.system.mrptEvent) |
| |
An event sent by a window upon when it's about to be closed, either
manually by the user or programmatically.
The event field member is default by default, but can be
set to false in the event callback
to forbid the window to be closed by the user. If the event corresponds to
a programatic close, this field is ignored.
IMPORTANTE NOTICE: Event handlers in your observer class will be invoked
from the wxWidgets internal MRPT thread,
so all your code in the handler must be thread safe.
CBaseGUIWindow
|
| |
- Method resolution order:
- mrptEventWindowClosed
- mrpt.pymrpt.mrpt.system.mrptEvent
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __init__(...)
- __init__(*args, **kwargs)
Overloaded function.
1. __init__(self: mrpt.pymrpt.mrpt.gui.mrptEventWindowClosed, arg0: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow) -> None
doc
2. __init__(self: mrpt.pymrpt.mrpt.gui.mrptEventWindowClosed, obj: mrpt.pymrpt.mrpt.gui.CBaseGUIWindow, _allow_close: bool) -> None
- assign(...)
- assign(self: mrpt.pymrpt.mrpt.gui.mrptEventWindowClosed, : mrpt.pymrpt.mrpt.gui.mrptEventWindowClosed) -> mrpt.pymrpt.mrpt.gui.mrptEventWindowClosed
C++: mrpt::gui::mrptEventWindowClosed::operator=(const class mrpt::gui::mrptEventWindowClosed &) --> class mrpt::gui::mrptEventWindowClosed &
Data descriptors defined here:
- allow_close
Data descriptors inherited from mrpt.pymrpt.mrpt.system.mrptEvent:
- timestamp
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class mrptKeyCode(pybind11_builtins.pybind11_object) |
| | |
- Method resolution order:
- mrptKeyCode
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __and__(...)
- __and__(self: object, other: object) -> object
- __eq__(...)
- __eq__(self: object, other: object) -> bool
- __ge__(...)
- __ge__(self: object, other: object) -> bool
- __getstate__(...)
- __getstate__(self: object) -> int
- __gt__(...)
- __gt__(self: object, other: object) -> bool
- __hash__(...)
- __hash__(self: object) -> int
- __index__(...)
- __index__(self: mrpt.pymrpt.mrpt.gui.mrptKeyCode) -> int
- __init__(...)
- __init__(self: mrpt.pymrpt.mrpt.gui.mrptKeyCode, value: int) -> None
- __int__(...)
- __int__(self: mrpt.pymrpt.mrpt.gui.mrptKeyCode) -> int
- __invert__(...)
- __invert__(self: object) -> object
- __le__(...)
- __le__(self: object, other: object) -> bool
- __lt__(...)
- __lt__(self: object, other: object) -> bool
- __ne__(...)
- __ne__(self: object, other: object) -> bool
- __or__(...)
- __or__(self: object, other: object) -> object
- __rand__(...)
- __rand__(self: object, other: object) -> object
- __repr__(...)
- __repr__(self: object) -> str
- __ror__(...)
- __ror__(self: object, other: object) -> object
- __rxor__(...)
- __rxor__(self: object, other: object) -> object
- __setstate__(...)
- __setstate__(self: mrpt.pymrpt.mrpt.gui.mrptKeyCode, state: int) -> None
- __str__ = name(...)
- name(self: handle) -> str
- __xor__(...)
- __xor__(self: object, other: object) -> object
Readonly properties defined here:
- __members__
- name
- name(self: handle) -> str
- value
Data and other attributes defined here:
- MRPTK_ADD = <mrptKeyCode.MRPTK_ADD: 335>
- MRPTK_ALT = <mrptKeyCode.MRPTK_ALT: 307>
- MRPTK_BACK = <mrptKeyCode.MRPTK_BACK: 8>
- MRPTK_CANCEL = <mrptKeyCode.MRPTK_CANCEL: 303>
- MRPTK_CAPITAL = <mrptKeyCode.MRPTK_CAPITAL: 311>
- MRPTK_CLEAR = <mrptKeyCode.MRPTK_CLEAR: 305>
- MRPTK_COMMAND = <mrptKeyCode.MRPTK_COMMAND: 396>
- MRPTK_CONTROL = <mrptKeyCode.MRPTK_CONTROL: 308>
- MRPTK_DECIMAL = <mrptKeyCode.MRPTK_DECIMAL: 338>
- MRPTK_DELETE = <mrptKeyCode.MRPTK_DELETE: 127>
- MRPTK_DIVIDE = <mrptKeyCode.MRPTK_DIVIDE: 339>
- MRPTK_DOWN = <mrptKeyCode.MRPTK_DOWN: 317>
- MRPTK_END = <mrptKeyCode.MRPTK_END: 312>
- MRPTK_ESCAPE = <mrptKeyCode.MRPTK_ESCAPE: 27>
- MRPTK_EXECUTE = <mrptKeyCode.MRPTK_EXECUTE: 320>
- MRPTK_F1 = <mrptKeyCode.MRPTK_F1: 340>
- MRPTK_F10 = <mrptKeyCode.MRPTK_F10: 349>
- MRPTK_F11 = <mrptKeyCode.MRPTK_F11: 350>
- MRPTK_F12 = <mrptKeyCode.MRPTK_F12: 351>
- MRPTK_F13 = <mrptKeyCode.MRPTK_F13: 352>
- MRPTK_F14 = <mrptKeyCode.MRPTK_F14: 353>
- MRPTK_F15 = <mrptKeyCode.MRPTK_F15: 354>
- MRPTK_F16 = <mrptKeyCode.MRPTK_F16: 355>
- MRPTK_F17 = <mrptKeyCode.MRPTK_F17: 356>
- MRPTK_F18 = <mrptKeyCode.MRPTK_F18: 357>
- MRPTK_F19 = <mrptKeyCode.MRPTK_F19: 358>
- MRPTK_F2 = <mrptKeyCode.MRPTK_F2: 341>
- MRPTK_F20 = <mrptKeyCode.MRPTK_F20: 359>
- MRPTK_F21 = <mrptKeyCode.MRPTK_F21: 360>
- MRPTK_F22 = <mrptKeyCode.MRPTK_F22: 361>
- MRPTK_F23 = <mrptKeyCode.MRPTK_F23: 362>
- MRPTK_F24 = <mrptKeyCode.MRPTK_F24: 363>
- MRPTK_F3 = <mrptKeyCode.MRPTK_F3: 342>
- MRPTK_F4 = <mrptKeyCode.MRPTK_F4: 343>
- MRPTK_F5 = <mrptKeyCode.MRPTK_F5: 344>
- MRPTK_F6 = <mrptKeyCode.MRPTK_F6: 345>
- MRPTK_F7 = <mrptKeyCode.MRPTK_F7: 346>
- MRPTK_F8 = <mrptKeyCode.MRPTK_F8: 347>
- MRPTK_F9 = <mrptKeyCode.MRPTK_F9: 348>
- MRPTK_HELP = <mrptKeyCode.MRPTK_HELP: 323>
- MRPTK_HOME = <mrptKeyCode.MRPTK_HOME: 313>
- MRPTK_INSERT = <mrptKeyCode.MRPTK_INSERT: 322>
- MRPTK_LBUTTON = <mrptKeyCode.MRPTK_LBUTTON: 301>
- MRPTK_LEFT = <mrptKeyCode.MRPTK_LEFT: 314>
- MRPTK_MBUTTON = <mrptKeyCode.MRPTK_MBUTTON: 304>
- MRPTK_MENU = <mrptKeyCode.MRPTK_MENU: 309>
- MRPTK_MULTIPLY = <mrptKeyCode.MRPTK_MULTIPLY: 334>
- MRPTK_NUMLOCK = <mrptKeyCode.MRPTK_NUMLOCK: 364>
- MRPTK_NUMPAD0 = <mrptKeyCode.MRPTK_NUMPAD0: 324>
- MRPTK_NUMPAD1 = <mrptKeyCode.MRPTK_NUMPAD1: 325>
- MRPTK_NUMPAD2 = <mrptKeyCode.MRPTK_NUMPAD2: 326>
- MRPTK_NUMPAD3 = <mrptKeyCode.MRPTK_NUMPAD3: 327>
- MRPTK_NUMPAD4 = <mrptKeyCode.MRPTK_NUMPAD4: 328>
- MRPTK_NUMPAD5 = <mrptKeyCode.MRPTK_NUMPAD5: 329>
- MRPTK_NUMPAD6 = <mrptKeyCode.MRPTK_NUMPAD6: 330>
- MRPTK_NUMPAD7 = <mrptKeyCode.MRPTK_NUMPAD7: 331>
- MRPTK_NUMPAD8 = <mrptKeyCode.MRPTK_NUMPAD8: 332>
- MRPTK_NUMPAD9 = <mrptKeyCode.MRPTK_NUMPAD9: 333>
- MRPTK_NUMPAD_ADD = <mrptKeyCode.MRPTK_NUMPAD_ADD: 388>
- MRPTK_NUMPAD_BEGIN = <mrptKeyCode.MRPTK_NUMPAD_BEGIN: 383>
- MRPTK_NUMPAD_DECIMAL = <mrptKeyCode.MRPTK_NUMPAD_DECIMAL: 391>
- MRPTK_NUMPAD_DELETE = <mrptKeyCode.MRPTK_NUMPAD_DELETE: 385>
- MRPTK_NUMPAD_DIVIDE = <mrptKeyCode.MRPTK_NUMPAD_DIVIDE: 392>
- MRPTK_NUMPAD_DOWN = <mrptKeyCode.MRPTK_NUMPAD_DOWN: 379>
- MRPTK_NUMPAD_END = <mrptKeyCode.MRPTK_NUMPAD_END: 382>
- MRPTK_NUMPAD_ENTER = <mrptKeyCode.MRPTK_NUMPAD_ENTER: 370>
- MRPTK_NUMPAD_EQUAL = <mrptKeyCode.MRPTK_NUMPAD_EQUAL: 386>
- MRPTK_NUMPAD_F1 = <mrptKeyCode.MRPTK_NUMPAD_F1: 371>
- MRPTK_NUMPAD_F2 = <mrptKeyCode.MRPTK_NUMPAD_F2: 372>
- MRPTK_NUMPAD_F3 = <mrptKeyCode.MRPTK_NUMPAD_F3: 373>
- MRPTK_NUMPAD_F4 = <mrptKeyCode.MRPTK_NUMPAD_F4: 374>
- MRPTK_NUMPAD_HOME = <mrptKeyCode.MRPTK_NUMPAD_HOME: 375>
- MRPTK_NUMPAD_INSERT = <mrptKeyCode.MRPTK_NUMPAD_INSERT: 384>
- MRPTK_NUMPAD_LEFT = <mrptKeyCode.MRPTK_NUMPAD_LEFT: 376>
- MRPTK_NUMPAD_MULTIPLY = <mrptKeyCode.MRPTK_NUMPAD_MULTIPLY: 387>
- MRPTK_NUMPAD_PAGEDOWN = <mrptKeyCode.MRPTK_NUMPAD_PAGEDOWN: 381>
- MRPTK_NUMPAD_PAGEUP = <mrptKeyCode.MRPTK_NUMPAD_PAGEUP: 380>
- MRPTK_NUMPAD_RIGHT = <mrptKeyCode.MRPTK_NUMPAD_RIGHT: 378>
- MRPTK_NUMPAD_SEPARATOR = <mrptKeyCode.MRPTK_NUMPAD_SEPARATOR: 389>
- MRPTK_NUMPAD_SPACE = <mrptKeyCode.MRPTK_NUMPAD_SPACE: 368>
- MRPTK_NUMPAD_SUBTRACT = <mrptKeyCode.MRPTK_NUMPAD_SUBTRACT: 390>
- MRPTK_NUMPAD_TAB = <mrptKeyCode.MRPTK_NUMPAD_TAB: 369>
- MRPTK_NUMPAD_UP = <mrptKeyCode.MRPTK_NUMPAD_UP: 377>
- MRPTK_PAGEDOWN = <mrptKeyCode.MRPTK_PAGEDOWN: 367>
- MRPTK_PAGEUP = <mrptKeyCode.MRPTK_PAGEUP: 366>
- MRPTK_PAUSE = <mrptKeyCode.MRPTK_PAUSE: 310>
- MRPTK_PRINT = <mrptKeyCode.MRPTK_PRINT: 319>
- MRPTK_RBUTTON = <mrptKeyCode.MRPTK_RBUTTON: 302>
- MRPTK_RETURN = <mrptKeyCode.MRPTK_RETURN: 13>
- MRPTK_RIGHT = <mrptKeyCode.MRPTK_RIGHT: 316>
- MRPTK_SCROLL = <mrptKeyCode.MRPTK_SCROLL: 365>
- MRPTK_SELECT = <mrptKeyCode.MRPTK_SELECT: 318>
- MRPTK_SEPARATOR = <mrptKeyCode.MRPTK_SEPARATOR: 336>
- MRPTK_SHIFT = <mrptKeyCode.MRPTK_SHIFT: 306>
- MRPTK_SNAPSHOT = <mrptKeyCode.MRPTK_SNAPSHOT: 321>
- MRPTK_SPACE = <mrptKeyCode.MRPTK_SPACE: 32>
- MRPTK_SPECIAL1 = <mrptKeyCode.MRPTK_SPECIAL1: 193>
- MRPTK_SPECIAL10 = <mrptKeyCode.MRPTK_SPECIAL10: 202>
- MRPTK_SPECIAL11 = <mrptKeyCode.MRPTK_SPECIAL11: 203>
- MRPTK_SPECIAL12 = <mrptKeyCode.MRPTK_SPECIAL12: 204>
- MRPTK_SPECIAL13 = <mrptKeyCode.MRPTK_SPECIAL13: 205>
- MRPTK_SPECIAL14 = <mrptKeyCode.MRPTK_SPECIAL14: 206>
- MRPTK_SPECIAL15 = <mrptKeyCode.MRPTK_SPECIAL15: 207>
- MRPTK_SPECIAL16 = <mrptKeyCode.MRPTK_SPECIAL16: 208>
- MRPTK_SPECIAL17 = <mrptKeyCode.MRPTK_SPECIAL17: 209>
- MRPTK_SPECIAL18 = <mrptKeyCode.MRPTK_SPECIAL18: 210>
- MRPTK_SPECIAL19 = <mrptKeyCode.MRPTK_SPECIAL19: 211>
- MRPTK_SPECIAL2 = <mrptKeyCode.MRPTK_SPECIAL2: 194>
- MRPTK_SPECIAL20 = <mrptKeyCode.MRPTK_SPECIAL20: 212>
- MRPTK_SPECIAL3 = <mrptKeyCode.MRPTK_SPECIAL3: 195>
- MRPTK_SPECIAL4 = <mrptKeyCode.MRPTK_SPECIAL4: 196>
- MRPTK_SPECIAL5 = <mrptKeyCode.MRPTK_SPECIAL5: 197>
- MRPTK_SPECIAL6 = <mrptKeyCode.MRPTK_SPECIAL6: 198>
- MRPTK_SPECIAL7 = <mrptKeyCode.MRPTK_SPECIAL7: 199>
- MRPTK_SPECIAL8 = <mrptKeyCode.MRPTK_SPECIAL8: 200>
- MRPTK_SPECIAL9 = <mrptKeyCode.MRPTK_SPECIAL9: 201>
- MRPTK_START = <mrptKeyCode.MRPTK_START: 300>
- MRPTK_SUBTRACT = <mrptKeyCode.MRPTK_SUBTRACT: 337>
- MRPTK_TAB = <mrptKeyCode.MRPTK_TAB: 9>
- MRPTK_UP = <mrptKeyCode.MRPTK_UP: 315>
- MRPTK_WINDOWS_LEFT = <mrptKeyCode.MRPTK_WINDOWS_LEFT: 393>
- MRPTK_WINDOWS_MENU = <mrptKeyCode.MRPTK_WINDOWS_MENU: 395>
- MRPTK_WINDOWS_RIGHT = <mrptKeyCode.MRPTK_WINDOWS_RIGHT: 394>
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
|
class mrptKeyModifier(pybind11_builtins.pybind11_object) |
| | |
- Method resolution order:
- mrptKeyModifier
- pybind11_builtins.pybind11_object
- builtins.object
Methods defined here:
- __and__(...)
- __and__(self: object, other: object) -> object
- __eq__(...)
- __eq__(self: object, other: object) -> bool
- __ge__(...)
- __ge__(self: object, other: object) -> bool
- __getstate__(...)
- __getstate__(self: object) -> int
- __gt__(...)
- __gt__(self: object, other: object) -> bool
- __hash__(...)
- __hash__(self: object) -> int
- __index__(...)
- __index__(self: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
- __init__(...)
- __init__(self: mrpt.pymrpt.mrpt.gui.mrptKeyModifier, value: int) -> None
- __int__(...)
- __int__(self: mrpt.pymrpt.mrpt.gui.mrptKeyModifier) -> int
- __invert__(...)
- __invert__(self: object) -> object
- __le__(...)
- __le__(self: object, other: object) -> bool
- __lt__(...)
- __lt__(self: object, other: object) -> bool
- __ne__(...)
- __ne__(self: object, other: object) -> bool
- __or__(...)
- __or__(self: object, other: object) -> object
- __rand__(...)
- __rand__(self: object, other: object) -> object
- __repr__(...)
- __repr__(self: object) -> str
- __ror__(...)
- __ror__(self: object, other: object) -> object
- __rxor__(...)
- __rxor__(self: object, other: object) -> object
- __setstate__(...)
- __setstate__(self: mrpt.pymrpt.mrpt.gui.mrptKeyModifier, state: int) -> None
- __str__ = name(...)
- name(self: handle) -> str
- __xor__(...)
- __xor__(self: object, other: object) -> object
Readonly properties defined here:
- __members__
- name
- name(self: handle) -> str
- value
Data and other attributes defined here:
- MRPTKMOD_ALT = <mrptKeyModifier.MRPTKMOD_ALT: 4096>
- MRPTKMOD_ALTGR = <mrptKeyModifier.MRPTKMOD_ALTGR: 12288>
- MRPTKMOD_CMD = <mrptKeyModifier.MRPTKMOD_CONTROL: 8192>
- MRPTKMOD_CONTROL = <mrptKeyModifier.MRPTKMOD_CONTROL: 8192>
- MRPTKMOD_META = <mrptKeyModifier.MRPTKMOD_META: 32768>
- MRPTKMOD_NONE = <mrptKeyModifier.MRPTKMOD_NONE: 0>
- MRPTKMOD_SHIFT = <mrptKeyModifier.MRPTKMOD_SHIFT: 16384>
- MRPTKMOD_WIN = <mrptKeyModifier.MRPTKMOD_META: 32768>
Static methods inherited from pybind11_builtins.pybind11_object:
- __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
- Create and return a new object. See help(type) for accurate signature.
| |