From 39dbfd55a64c51c467df909cc6e038cd0365fde0 Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavier.robin@unibas.ch>
Date: Fri, 7 Jul 2023 13:54:46 +0200
Subject: [PATCH] doc: add missing functions/methods from entity view
---
modules/mol/base/doc/entity.rst | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/modules/mol/base/doc/entity.rst b/modules/mol/base/doc/entity.rst
index a41729c3e..b854b2b24 100644
--- a/modules/mol/base/doc/entity.rst
+++ b/modules/mol/base/doc/entity.rst
@@ -1660,6 +1660,26 @@ Entity View
is not part of the view
:rtype: (Chain\|Residue\|Atom)View
+ .. method:: ExtendViewToResidues()
+
+ Extend current view to include all atoms of each residue where
+ at least one atom is selected currently.
+
+ :returns: The extended view
+ :rtype: :class:`EntityView`
+
+ .. method:: ExtendViewToSurrounding(handle)
+
+ Extend current view to include all atoms that are within the sum
+ of their van-der-Waals radius + gap.
+
+ This includes all atoms within: at1.GetRadius() + at2.GetRadius() + gap.
+
+ :param gap: the gap between atoms
+ :type gap: float
+ :returns: The extended view
+ :rtype: :class:`EntityView`
+
.. method:: Select(query, flags=0)
Perform selection on entity view. See :meth:`EntityHandle.Select`.
@@ -1680,6 +1700,12 @@ Entity View
:rtype: :class:`EntityView`
+ .. method:: Dump()
+
+ Returns a string containing a human-readable summary of the entity view.
+
+ :rtype: :class:`str`
+
.. method:: GetMass()
Get total mass of view.
@@ -2272,6 +2298,7 @@ Boolean Operators
Other Entity-Related Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. function:: CreateViewFromAtoms(atom_list)
.. function:: CreateViewFromAtomList(atom_list)
Returns a view made up of the atoms in *atom_list*. All atoms are required to
--
GitLab