Skip to content
Snippets Groups Projects
Commit c1d67e30 authored by Xavier Robin's avatar Xavier Robin
Browse files

Clarify to use XCSEditor to access EditorBase functions

parent fff160f0
No related branches found
No related tags found
No related merge requests found
......@@ -41,6 +41,12 @@ Basic Editing Operations
The basic functionality of editors is implemented in the EditorBase class.
.. note::
To use the editing functions available in :class:`EditorBase`, it is
recommended to use the external coordinate system :class:`XCSEditor` for
performance reasons.
.. class:: EditorBase
Inherited by :class:`XCSEditor`, :class:`ICSEditor`.
......@@ -486,6 +492,13 @@ using an :class:`ICSEditor` is undefined and vice versa.
a directed-graph for the bond network as well as calculating the internal
coordinate matrices.
.. warning::
The :class:`ICSEditor` has a very significant performance impact on the
structure, and can make subsequent access or modifications on the entity
extremely slow due to lazy evaluation. The :class:`ICSEditor` is never used
in SWISS-MODEL, ProMod3 or CAMEO. Only open one if you absolutely need to.
.. class:: ICSEditor
Inherits :class:`EditorBase`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment