From a6ab9be5a6a9b28fe0fc715175adf0a3604d9982 Mon Sep 17 00:00:00 2001 From: Anatoly Baksheev Date: Sun, 24 Nov 2013 20:10:14 +0400 Subject: [PATCH] removed VizAccessor from docs --- modules/viz/doc/viz3d.rst | 62 --------------------------------------- 1 file changed, 62 deletions(-) diff --git a/modules/viz/doc/viz3d.rst b/modules/viz/doc/viz3d.rst index 79e262bb9..2f8dfcd9d 100644 --- a/modules/viz/doc/viz3d.rst +++ b/modules/viz/doc/viz3d.rst @@ -76,68 +76,6 @@ Checks **point** for nan :param p: return true if **any** of the elements of the point is *nan*. -viz::VizAccessor ----------------- -.. ocv:class:: VizAccessor - -A singleton class that provides access by name infrastructure for 3D visualization windows. :: - - class CV_EXPORTS VizAccessor - { - public: - static VizAccessor & getInstance(); - static void release(); - - Viz3d get(const String &window_name); - - //! window names automatically have Viz - prefix even though not provided by the users - static void generateWindowName(const String &window_name, String &output); - - private: - /* hidden */ - }; - -viz::VizAccessor::getInstance ------------------------------ -Returns the single instance of VizAccessor. - -.. ocv:function:: static VizAccessor & getInstance() - -viz::VizAccessor::release -------------------------- -Deletes the single instance of VizAccessor. - -.. ocv:function:: static void release() - -viz::VizAccessor::get ---------------------- -Retrieves a window by its name. - -.. ocv:function:: Viz3d get(const String &window_name) - - :param window_name: Name of the window that is to be retrieved. - -This function returns a :ocv:class:`Viz3d` object with the given name. - -.. note:: If the window with that name already exists, that window is returned. Otherwise, new window is created with the given name, and it is returned. - -.. note:: Window names are automatically prefixed by "Viz - " if it is not done by the user. - - .. code-block:: cpp - - /// window and window_2 are the same windows. - viz::Viz3d window = viz::get("myWindow"); - viz::Viz3d window_2 = viz::get("Viz - myWindow"); - -viz::VizAccessor::generateWindowName ------------------------------------- -Generates a window name by prefixing "Viz - " if it has not already been prefixed. - -.. ocv:function:: static void generateWindowName(const String &window_name, String &output) - - :param window_name: Window name - :param output: Prefixed window name - viz::Viz3d ---------- .. ocv:class:: Viz3d