ic
/
magnum-bindings
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

python: turns out documenting function overloads *is* possible. 

Some documentation content was already using this, I just completely
forgot it was there. Heh.
next
Vladimír Vondruš 3 years ago
parent
f9d1fdecf3
commit
f9473638fc
3 changed files with 131 additions and 39 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      doc/python/corrade.utility.rst
  2. 14
      doc/python/magnum.scenetools.rst
  3. 154
      doc/python/magnum.trade.rst

2
doc/python/corrade.utility.rst
Unescape View File

@ -29,7 +29,7 @@
.. py:function:: corrade.utility.ConfigurationGroup.group .. py:function:: corrade.utility.ConfigurationGroup.group
:raise KeyError: If group :p:`name` doesn't exist :raise KeyError: If group :p:`name` doesn't exist
.. py:function:: corrade.utility.Configuration.__init__ .. py:function:: corrade.utility.Configuration.__init__(self, filename: str)
:raise IOError: If :p:`filename` contains a parse error :raise IOError: If :p:`filename` contains a parse error
.. py:function:: corrade.utility.Configuration.save .. py:function:: corrade.utility.Configuration.save

14
doc/python/magnum.scenetools.rst
Unescape View File

@ -47,16 +47,26 @@
:raise AssertionError: If :p:`scene` does not have :raise AssertionError: If :p:`scene` does not have
:ref:`trade.SceneField.PARENT` :ref:`trade.SceneField.PARENT`
.. py:function:: magnum.scenetools.absolute_field_transformations2d .. py:function:: magnum.scenetools.absolute_field_transformations2d(scene: magnum.trade.SceneData, field: magnum.trade.SceneField, global_transformation: magnum.Matrix3)
:raise KeyError: If :p:`field` does not exist in :p:`scene` :raise KeyError: If :p:`field` does not exist in :p:`scene`
:raise AssertionError: If :p:`scene` is not 2D
:raise AssertionError: If :p:`scene` does not have
:ref:`trade.SceneField.PARENT`
.. py:function:: magnum.scenetools.absolute_field_transformations2d(scene: magnum.trade.SceneData, field_id: int, global_transformation: magnum.Matrix3)
:raise IndexError: If :p:`field_id` negative or not less than :raise IndexError: If :p:`field_id` negative or not less than
:ref:`trade.SceneData.field_count` :ref:`trade.SceneData.field_count`
:raise AssertionError: If :p:`scene` is not 2D :raise AssertionError: If :p:`scene` is not 2D
:raise AssertionError: If :p:`scene` does not have :raise AssertionError: If :p:`scene` does not have
:ref:`trade.SceneField.PARENT` :ref:`trade.SceneField.PARENT`
.. py:function:: magnum.scenetools.absolute_field_transformations3d .. py:function:: magnum.scenetools.absolute_field_transformations3d(scene: magnum.trade.SceneData, field: magnum.trade.SceneField, global_transformation: magnum.Matrix4)
:raise KeyError: If :p:`field` does not exist in :p:`scene` :raise KeyError: If :p:`field` does not exist in :p:`scene`
:raise AssertionError: If :p:`scene` is not 2D
:raise AssertionError: If :p:`scene` does not have
:ref:`trade.SceneField.PARENT`
.. py:function:: magnum.scenetools.absolute_field_transformations3d(scene: magnum.trade.SceneData, field_id: int, global_transformation: magnum.Matrix4)
:raise IndexError: If :p:`field_id` negative or not less than :raise IndexError: If :p:`field_id` negative or not less than
:ref:`trade.SceneData.field_count` :ref:`trade.SceneData.field_count`
:raise AssertionError: If :p:`scene` is not 2D :raise AssertionError: If :p:`scene` is not 2D

154
doc/python/magnum.trade.rst
Unescape View File

@ -206,9 +206,10 @@
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute_id .. py:function:: magnum.trade.MeshData.attribute_id(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute_id(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
@ -216,34 +217,42 @@
:dox:`Trade::MeshData::findAttributeId()`, the desired workflow is instead :dox:`Trade::MeshData::findAttributeId()`, the desired workflow is instead
calling :ref:`attribute_id()` and catching an exception if not found. calling :ref:`attribute_id()` and catching an exception if not found.
.. py:function:: magnum.trade.MeshData.attribute_format .. py:function:: magnum.trade.MeshData.attribute_format(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute_format(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
.. py:function:: magnum.trade.MeshData.attribute_offset .. py:function:: magnum.trade.MeshData.attribute_offset(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute_offset(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
.. py:function:: magnum.trade.MeshData.attribute_stride .. py:function:: magnum.trade.MeshData.attribute_stride(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute_stride(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
.. py:function:: magnum.trade.MeshData.attribute_array_size .. py:function:: magnum.trade.MeshData.attribute_array_size(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute_array_size(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
.. py:function:: magnum.trade.MeshData.attribute .. py:function:: magnum.trade.MeshData.attribute(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
.. py:function:: magnum.trade.MeshData.attribute(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
.. py:function:: magnum.trade.MeshData.mutable_attribute .. py:function:: magnum.trade.MeshData.mutable_attribute(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`attribute_count()` :ref:`attribute_count()`
:raise AttributeError: If :ref:`vertex_data_flags` doesn't contain
:ref:`DataFlags.MUTABLE`
.. py:function:: magnum.trade.MeshData.mutable_attribute(self, name: magnum.trade.MeshAttribute, id: int)
:raise KeyError: If :p:`id` is negative or not less than :raise KeyError: If :p:`id` is negative or not less than
:ref:`attribute_count()` for :p:`name` :ref:`attribute_count()` for :p:`name`
:raise AttributeError: If :ref:`vertex_data_flags` doesn't contain :raise AttributeError: If :ref:`vertex_data_flags` doesn't contain
@ -315,36 +324,49 @@
.. py:function:: magnum.trade.SceneData.field_name .. py:function:: magnum.trade.SceneData.field_name
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`field_count` :ref:`field_count`
.. py:function:: magnum.trade.SceneData.field_flags .. py:function:: magnum.trade.SceneData.field_flags(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`field_count` :ref:`field_count`
.. py:function:: magnum.trade.SceneData.field_flags(self, name: magnum.trade.SceneField)
:raise KeyError: If :p:`name` does not exist :raise KeyError: If :p:`name` does not exist
.. py:function:: magnum.trade.SceneData.field_type .. py:function:: magnum.trade.SceneData.field_type(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`field_count` :ref:`field_count`
.. py:function:: magnum.trade.SceneData.field_type(self, name: magnum.trade.SceneField)
:raise KeyError: If :p:`name` does not exist :raise KeyError: If :p:`name` does not exist
.. py:function:: magnum.trade.SceneData.field_size .. py:function:: magnum.trade.SceneData.field_size(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`field_count` :ref:`field_count`
.. py:function:: magnum.trade.SceneData.field_size(self, name: magnum.trade.SceneField)
:raise KeyError: If :p:`name` does not exist :raise KeyError: If :p:`name` does not exist
.. py:function:: magnum.trade.SceneData.field_array_size .. py:function:: magnum.trade.SceneData.field_array_size(self, id: int)
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`field_count` :ref:`field_count`
.. py:function:: magnum.trade.SceneData.field_array_size(self, name: magnum.trade.SceneField)
:raise KeyError: If :p:`name` does not exist :raise KeyError: If :p:`name` does not exist
.. py:function:: magnum.trade.SceneData.field_id .. py:function:: magnum.trade.SceneData.field_id
:raise KeyError: If :p:`name` does not exist :raise KeyError: If :p:`name` does not exist
.. py:function:: magnum.trade.SceneData.field_object_offset .. py:function:: magnum.trade.SceneData.field_object_offset(self, field_id: int, object: int, offset: int)
:raise IndexError: If :p:`field_id` is negative or not less than :raise IndexError: If :p:`field_id` is negative or not less than
:ref:`field_count` :ref:`field_count`
:raise IndexError: If :p:`object` is negative or not less than
:ref:`mapping_bound`
:raise IndexError: If :p:`offset` is negative or larger than
:ref:`field_size()` for given field
:raise LookupError: If :p:`object` is not found
.. py:function:: magnum.trade.SceneData.field_object_offset(self, field_name: magnum.trade.SceneField, object: int, offset: int)
:raise KeyError: If :p:`field_name` does not exist :raise KeyError: If :p:`field_name` does not exist
:raise IndexError: If :p:`object` is negative or not less than :raise IndexError: If :p:`object` is negative or not less than
:ref:`mapping_bound` :ref:`mapping_bound`
:raise IndexError: If :p:`offset` is negative or larger than :raise IndexError: If :p:`offset` is negative or larger than
:ref:`field_size()` for given field :ref:`field_size()` for given field
:raise LookupError: If :p:`object` is not found :raise LookupError: If :p:`object` is not found
.. py:function:: magnum.trade.SceneData.has_field_object .. py:function:: magnum.trade.SceneData.has_field_object(self, field_id: int, object: int)
:raise IndexError: If :p:`field_id` is negative or not less than :raise IndexError: If :p:`field_id` is negative or not less than
:ref:`field_count` :ref:`field_count`
:raise IndexError: If :p:`object` is negative or not less than
:ref:`mapping_bound`
.. py:function:: magnum.trade.SceneData.has_field_object(self, field_name: magnum.trade.SceneField, object: int)
:raise KeyError: If :p:`field_name` does not exist :raise KeyError: If :p:`field_name` does not exist
:raise IndexError: If :p:`object` is negative or not less than :raise IndexError: If :p:`object` is negative or not less than
:ref:`mapping_bound` :ref:`mapping_bound`
@ -410,12 +432,13 @@
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise IndexError: If :p:`id` is negative or not less than :ref:`object_count` :raise IndexError: If :p:`id` is negative or not less than :ref:`object_count`
.. TODO this needs distinction by parameter names, at least .. py:function:: magnum.trade.AbstractImporter.scene(self, id: int)
.. py:function:: magnum.trade.AbstractImporter.scene
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise RuntimeError: If scene import fails :raise RuntimeError: If scene import fails
:raise IndexError: If :p:`id` is negative or not less than :ref:`scene` :raise IndexError: If :p:`id` is negative or not less than :ref:`scene`
.. py:function:: magnum.trade.AbstractImporter.scene(self, name: str)
:raise AssertionError: If no file is opened
:raise RuntimeError: If scene import fails
:raise KeyError: If :p:`name` was not found :raise KeyError: If :p:`name` was not found
.. py:property:: magnum.trade.AbstractImporter.mesh_count .. py:property:: magnum.trade.AbstractImporter.mesh_count
@ -429,13 +452,19 @@
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise IndexError: If :p:`id` is negative or not less than :ref:`mesh_count` :raise IndexError: If :p:`id` is negative or not less than :ref:`mesh_count`
.. TODO this needs distinction by parameter names, at least .. py:function:: magnum.trade.AbstractImporter.mesh(self, id: int, level: int)
.. py:function:: magnum.trade.AbstractImporter.mesh
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise RuntimeError: If mesh import fails :raise RuntimeError: If mesh import fails
:raise IndexError: If :p:`id` is negative or not less than :ref:`mesh_count` :raise IndexError: If :p:`id` is negative or not less than :ref:`mesh_count`
:raise IndexError: If :p:`level` is negative or not less than
:ref:`mesh_level_count()` for this mesh
.. py:function:: magnum.trade.AbstractImporter.mesh(self, name: str, level: int)
:raise AssertionError: If no file is opened
:raise RuntimeError: If mesh import fails
:raise KeyError: If :p:`name` was not found :raise KeyError: If :p:`name` was not found
:raise IndexError: If :p:`level` is negative or not less than
:ref:`mesh_level_count()` for this mesh
.. py:property:: magnum.trade.AbstractImporter.texture_count .. py:property:: magnum.trade.AbstractImporter.texture_count
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
@ -445,12 +474,13 @@
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise IndexError: If :p:`id` is negative or not less than :ref:`texture_count` :raise IndexError: If :p:`id` is negative or not less than :ref:`texture_count`
.. TODO this needs distinction by parameter names, at least .. py:function:: magnum.trade.AbstractImporter.texture(self, id: int)
.. py:function:: magnum.trade.AbstractImporter.texture
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise RuntimeError: If texture import fails :raise RuntimeError: If texture import fails
:raise IndexError: If :p:`id` is negative or not less than :ref:`texture_count` :raise IndexError: If :p:`id` is negative or not less than :ref:`texture_count`
.. py:function:: magnum.trade.AbstractImporter.texture(self, name: str)
:raise AssertionError: If no file is opened
:raise RuntimeError: If texture import fails
:raise KeyError: If :p:`name` was not found :raise KeyError: If :p:`name` was not found
.. py:property:: magnum.trade.AbstractImporter.image1d_count .. py:property:: magnum.trade.AbstractImporter.image1d_count
@ -493,26 +523,45 @@
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`image3d_count` :ref:`image3d_count`
.. TODO this needs distinction by parameter names, at least .. py:function:: magnum.trade.AbstractImporter.image1d(self, id: int, level: int)
.. py:function:: magnum.trade.AbstractImporter.image1d
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise RuntimeError: If image import fails :raise RuntimeError: If image import fails
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`image1d_count` :ref:`image1d_count`
:raise IndexError: If :p:`level` is negative or not less than
:ref:`image1d_level_count()` for this image
.. py:function:: magnum.trade.AbstractImporter.image1d(self, name: str, level: int)
:raise AssertionError: If no file is opened
:raise RuntimeError: If image import fails
:raise KeyError: If :p:`name` was not found :raise KeyError: If :p:`name` was not found
.. py:function:: magnum.trade.AbstractImporter.image2d :raise IndexError: If :p:`level` is negative or not less than
:ref:`image1d_level_count()` for this image
.. py:function:: magnum.trade.AbstractImporter.image2d(self, id: int, level: int)
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise RuntimeError: If image import fails :raise RuntimeError: If image import fails
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`image2d_count` :ref:`image2d_count`
:raise IndexError: If :p:`level` is negative or not less than
:ref:`image2d_level_count()` for this image
.. py:function:: magnum.trade.AbstractImporter.image2d(self, name: str, level: int)
:raise AssertionError: If no file is opened
:raise RuntimeError: If image import fails
:raise KeyError: If :p:`name` was not found :raise KeyError: If :p:`name` was not found
.. py:function:: magnum.trade.AbstractImporter.image3d :raise IndexError: If :p:`level` is negative or not less than
:ref:`image2d_level_count()` for this image
.. py:function:: magnum.trade.AbstractImporter.image3d(self, id: int, level: int)
:raise AssertionError: If no file is opened :raise AssertionError: If no file is opened
:raise RuntimeError: If image import fails :raise RuntimeError: If image import fails
:raise IndexError: If :p:`id` is negative or not less than :raise IndexError: If :p:`id` is negative or not less than
:ref:`image3d_count` :ref:`image3d_count`
:raise IndexError: If :p:`level` is negative or not less than
:ref:`image3d_level_count()` for this image
.. py:function:: magnum.trade.AbstractImporter.image3d(self, name: str, level: int)
:raise AssertionError: If no file is opened
:raise RuntimeError: If image import fails
:raise KeyError: If :p:`name` was not found :raise KeyError: If :p:`name` was not found
:raise IndexError: If :p:`level` is negative or not less than
:ref:`image3d_level_count()` for this image
.. py:class:: magnum.trade.ImageConverterManager .. py:class:: magnum.trade.ImageConverterManager
:summary: Manager for :ref:`AbstractImageConverter` plugin instances :summary: Manager for :ref:`AbstractImageConverter` plugin instances
@ -546,10 +595,30 @@
raising an exception. See particular function documentation for detailed raising an exception. See particular function documentation for detailed
behavior. behavior.
.. py:function:: magnum.trade.AbstractImageConverter.convert .. py:function:: magnum.trade.AbstractImageConverter.convert(self, image: magnum.ImageView1D)
:raise RuntimeError: If image conversion fails
.. py:function:: magnum.trade.AbstractImageConverter.convert(self, image: magnum.ImageView2D)
:raise RuntimeError: If image conversion fails
.. py:function:: magnum.trade.AbstractImageConverter.convert(self, image: magnum.ImageView3D)
:raise RuntimeError: If image conversion fails :raise RuntimeError: If image conversion fails
.. py:function:: magnum.trade.AbstractImageConverter.convert_to_file .. py:function:: magnum.trade.AbstractImageConverter.convert_to_file(self, image: magnum.ImageView1D, filename: str)
:raise RuntimeError: If image conversion fails
For compatibility with :ref:`os.path`, on Windows this function converts
all backslashes in :p:`filename` to forward slashes before passing it to
:dox:`Trade::AbstractImageConverter::convertToFile()`, which expects
forward slashes as directory separators on all platforms.
.. py:function:: magnum.trade.AbstractImageConverter.convert_to_file(self, image: magnum.ImageView2D, filename: str)
:raise RuntimeError: If image conversion fails
For compatibility with :ref:`os.path`, on Windows this function converts
all backslashes in :p:`filename` to forward slashes before passing it to
:dox:`Trade::AbstractImageConverter::convertToFile()`, which expects
forward slashes as directory separators on all platforms.
.. py:function:: magnum.trade.AbstractImageConverter.convert_to_file(self, image: magnum.ImageView3D, filename: str)
:raise RuntimeError: If image conversion fails :raise RuntimeError: If image conversion fails
For compatibility with :ref:`os.path`, on Windows this function converts For compatibility with :ref:`os.path`, on Windows this function converts
@ -595,17 +664,17 @@
raising an exception. See particular function documentation for detailed raising an exception. See particular function documentation for detailed
behavior. behavior.
.. py:function:: magnum.trade.AbstractSceneConverter.convert .. py:function:: magnum.trade.AbstractSceneConverter.convert(self, mesh: magnum.trade.MeshData)
:raise AssertionError: If :ref:`trade.SceneConverterFeatures.CONVERT_MESH` :raise AssertionError: If :ref:`trade.SceneConverterFeatures.CONVERT_MESH`
is not supported is not supported
:raise RuntimeError: If conversion fails :raise RuntimeError: If conversion fails
.. py:function:: magnum.trade.AbstractSceneConverter.convert_in_place .. py:function:: magnum.trade.AbstractSceneConverter.convert_in_place(self, mesh: magnum.trade.MeshData)
:raise AssertionError: If :ref:`trade.SceneConverterFeatures.CONVERT_MESH_IN_PLACE` :raise AssertionError: If :ref:`trade.SceneConverterFeatures.CONVERT_MESH_IN_PLACE`
is not supported is not supported
:raise RuntimeError: If conversion fails :raise RuntimeError: If conversion fails
.. py:function:: magnum.trade.AbstractSceneConverter.convert_to_file .. py:function:: magnum.trade.AbstractSceneConverter.convert_to_file(self, mesh: magnum.trade.MeshData, filename: str)
:raise AssertionError: If neither :raise AssertionError: If neither
:ref:`SceneConverterFeatures.CONVERT_MESH_TO_FILE` nor the :ref:`SceneConverterFeatures.CONVERT_MESH_TO_FILE` nor the
combination of :ref:`SceneConverterFeatures.CONVERT_MULTIPLE_TO_FILE` combination of :ref:`SceneConverterFeatures.CONVERT_MULTIPLE_TO_FILE`
@ -639,14 +708,27 @@
.. py:property:: magnum.trade.AbstractSceneConverter.scene_count .. py:property:: magnum.trade.AbstractSceneConverter.scene_count
:raise AssertionError: If no conversion is in progress :raise AssertionError: If no conversion is in progress
.. py:function:: magnum.trade.AbstractSceneConverter.add .. py:function:: magnum.trade.AbstractSceneConverter.add(self, scene: magnum.trade.SceneData, name: str)
:raise AssertionError: If corresponding :raise AssertionError: If :ref:`SceneConverterFeatures.ADD_SCENES` is not
:ref:`SceneConverterFeatures.ADD_* <SceneConverterFeatures>` is not supported
:raise AssertionError: If no conversion is in progress
:raise RuntimeError: If adding the data fails
.. py:function:: magnum.trade.AbstractSceneConverter.add(self, mesh: magnum.trade.MeshData, name: str)
:raise AssertionError: If :ref:`SceneConverterFeatures.ADD_MESHES` is not
supported, or alternatively at least one of supported, or alternatively at least one of
:ref:`SceneConverterFeatures.CONVERT_MESH`, :ref:`SceneConverterFeatures.CONVERT_MESH`,
:ref:`SceneConverterFeatures.CONVERT_MESH_TO_DATA` or :ref:`SceneConverterFeatures.CONVERT_MESH_TO_DATA` or
:ref:`SceneConverterFeatures.CONVERT_MESH_TO_FILE` is not supported :ref:`SceneConverterFeatures.CONVERT_MESH_TO_FILE` is not supported
for meshes :raise AssertionError: If no conversion is in progress
:raise RuntimeError: If adding the data fails
.. py:function:: magnum.trade.AbstractSceneConverter.add(self, image: magnum.trade.ImageData2D, name: str)
:raise AssertionError: If :ref:`ImageData2D.is_compressed` is :py:`False`
and :ref:`SceneConverterFeatures.ADD_IMAGES2D` is not supported
:raise AssertionError: If :ref:`ImageData2D.is_compressed` is :py:`True`
and :ref:`SceneConverterFeatures.ADD_COMPRESSED_IMAGES2D` is not
supported
:raise AssertionError: If no conversion is in progress :raise AssertionError: If no conversion is in progress
:raise RuntimeError: If adding the data fails :raise RuntimeError: If adding the data fails

Write Preview
Loading…
Cancel
Save