diff --git a/modules/gui/doc/scene_win.rst b/modules/gui/doc/scene_win.rst index fcb6b9a27cfdea498b0cfa8a16004c573d98ab7f..8d3f5f69833973b614ca27cf32def17baf87daac 100644 --- a/modules/gui/doc/scene_win.rst +++ b/modules/gui/doc/scene_win.rst @@ -2,7 +2,7 @@ Scene Window ================================================================================ .. currentmodule:: ost.gui -The scene win holds a list of all graphical objects currently registered to +The scene window holds a list of all graphical objects currently registered to the :class:`gfx.Scene`. .. image:: images/100208_Scene_Win.png @@ -40,10 +40,10 @@ Context Menu The Context Menu of the Scene Window is context sensitive. So, dependent on what is selected in the :class:`SceneWin` the context menu changes. -Context menu of an entity +Context menu of an entity: .. image:: images/100614_entity_context_menu.png -Context menu of an entity view +Context menu of an entity view: .. image:: images/100614_context_menu_view.png It is possible to extend the Context Menu from python, by creating a QAction and @@ -53,7 +53,7 @@ be shown. .. code-block:: python - cm=gui.GostyApp.Instance().scene_win.GetContextMenu() + cm = gui.GostyApp.Instance().scene_win.GetContextMenu() action = QtGui.QAction("Test single entity", cm.qobject) cm.AddAction(action, gui.ContextActionType.ENTITY | gui.ContextActionType.SINGLE) @@ -121,4 +121,4 @@ be shown. ctx_act_types = gui.ContextActionType.ENTITY | gui.ContextActionType.SINGLE - \ No newline at end of file + diff --git a/modules/gui/doc/tools.rst b/modules/gui/doc/tools.rst index 1b652f2114c7ee83505861f6d6e4ffe7b50b0166..8b4d6eaee4c1e9316f113b0da1118e6eeddd4054 100644 --- a/modules/gui/doc/tools.rst +++ b/modules/gui/doc/tools.rst @@ -2,7 +2,7 @@ Tools -------------------------------------------------------------------------------- .. currentmodule:: ost.gui -OpenStructure has several :class:`Tool` which are all listed in the toolbar +OpenStructure has several :class:`Tool` options that are all listed in the toolbar close to the 3D window. A tool is activated upon selecting it in the toolbar. Input events are sent to the tool as long as the `Ctrl` key (`Cmd` on Mac) is pressed. For example the rigid body manipulator will rotate and shift the @@ -14,7 +14,7 @@ scene objects. .. image:: images/100208_Tools.png The example `Write a Tool in Python` demonstrates how to add a simple tool -(written in python) to OpenStructure. +(written in Python) to OpenStructure. .. class:: Tool @@ -34,7 +34,7 @@ The example `Write a Tool in Python` demonstrates how to add a simple tool .. method:: CanOperateOn(nodes) - determines if the tool can manipulate a certain :class:`gfx.GfxNode`. + Determines if the tool can manipulate a certain :class:`gfx.GfxNode`. This method is used to enabled/disable certain actions (in the toolbar, for example). Return True if the Tool can operate on all GfxNodes which are in the given list. Otherwise False @@ -45,14 +45,14 @@ The example `Write a Tool in Python` demonstrates how to add a simple tool .. method:: Click(event) - left mouse click + Left mouse click :param event: object with the event information :type arg2: :class:`MouseEvent` .. method:: DoubleClick(event) - double click + Double click :param event: object with the event information :type event: :class:`MouseEvent` @@ -89,15 +89,15 @@ The example `Write a Tool in Python` demonstrates how to add a simple tool .. class:: ToolOptionInt(key, verbose_name, default_value, min_value, max_value) - :param key: Internal key name + :param key: Internal key name. :type name: str - :param verbose_name: Name used as label in the widget + :param verbose_name: Name used as label in the widget. :type name: str - :param default_value: Default value - :param min_value: Minimum allowed value - Defaults to minimum possible value - :param max_value: Maximum allowed value - Defaults to maximum possible value + :param default_value: Default value. + :param min_value: Minimum allowed value. + Defaults to minimum possible value. + :param max_value: Maximum allowed value. + Defaults to maximum possible value. .. method:: GetDefault() @@ -114,13 +114,13 @@ The example `Write a Tool in Python` demonstrates how to add a simple tool :param key: Internal key name :type name: str - :param verbose_name: Name used as label in the widget + :param verbose_name: Name used as label in the widget. :type name: str - :param default_value: Default value - :param min_value: Minimum allowed value - Defaults to minimum possible value - :param max_value: Maximum allowed value - Defaults to maximum possible value + :param default_value: Default value. + :param min_value: Minimum allowed value. + Defaults to minimum possible value. + :param max_value: Maximum allowed value. + Defaults to maximum possible value. .. method:: GetDefault() @@ -168,4 +168,4 @@ The example `Write a Tool in Python` demonstrates how to add a simple tool :type slot_method: const char * :param receiver: QObject that implements the slot method :type receiver: QObject * - \ No newline at end of file +