.. role:: ts-api-decorator

.. _InstanceModifier:

################
InstanceModifier
################

.. container:: ts-api-section

   Enumerates instance modifier modes. More information can be found [here](https://docs.techsoft3d.com/communicator/latest/prog_guide/viewing/model_attributes/instance-modifiers.html).



.. container:: api-index-section

   .. rubric:: Enumeration Members

   .. rst-class:: api-index-list-item api-kind-enummember api-parent-kind-enum

   * :ref:`InstanceModifier.AlwaysDraw`
   * :ref:`InstanceModifier.DoNotCut`
   * :ref:`InstanceModifier.DoNotExplode`
   * :ref:`InstanceModifier.DoNotLight`
   * :ref:`InstanceModifier.DoNotOutlineHighlight`
   * :ref:`InstanceModifier.DoNotReset`
   * :ref:`InstanceModifier.DoNotSelect`
   * :ref:`InstanceModifier.DoNotUseVertexColors`
   * :ref:`InstanceModifier.DoNotXRay`
   * :ref:`InstanceModifier.ExcludeBounding`
   * :ref:`InstanceModifier.OverrideSceneVisibility`
   * :ref:`InstanceModifier.ScreenOriented`
   * :ref:`InstanceModifier.ScreenSpace`
   * :ref:`InstanceModifier.ScreenSpaceStretched`
   * :ref:`InstanceModifier.SuppressCameraScale`





------------

Enumeration Members
===================

.. rst-class:: ts-api-section

.. _InstanceModifier.AlwaysDraw:

AlwaysDraw
----------

If set, the instance will be drawn before other instances
and will not be culled in order to reach the target frame rate.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotCut:

DoNotCut
--------

If set, the instance will not be affected by cutting planes.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotExplode:

DoNotExplode
------------

If set, the instance will not be affected by an explode operation.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotLight:

DoNotLight
----------

If set, the instance will not be lit.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotOutlineHighlight:

DoNotOutlineHighlight
---------------------

If set, the instance will not be outlined when highlighted.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotReset:

DoNotReset
----------

If set, the instance will not be affected by resets. Or by methods
that unset or reset certain properties on the instance

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotSelect:

DoNotSelect
-----------

If set, the instance will not be selectable.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotUseVertexColors:

DoNotUseVertexColors
--------------------

If set, the instance will not use the mesh's per-vertex colors.

.. rst-class:: ts-api-section

.. _InstanceModifier.DoNotXRay:

DoNotXRay
---------

If set, the instance will not be affected by [[DrawMode.XRay]].

.. rst-class:: ts-api-section

.. _InstanceModifier.ExcludeBounding:

ExcludeBounding
---------------

If set, the instance will not be included in bounding calculations.

.. rst-class:: ts-api-section

.. _InstanceModifier.OverrideSceneVisibility:

OverrideSceneVisibility
-----------------------

If set, the instance will ignore scene-level visibility.

.. rst-class:: ts-api-section

.. _InstanceModifier.ScreenOriented:

ScreenOriented
--------------

If set, the instance will be oriented such that the cardinal
axes of object space are aligned with the cardinal axes of
screen space.

.. rst-class:: ts-api-section

.. _InstanceModifier.ScreenSpace:

ScreenSpace
-----------

If set, the instance will be drawn in a space that extends
from X=-1 at the left side of the screen to X=1 at the right
side of the screen and from Y=-1 at the bottom of the screen
to Y=1 at the top of the screen.

If the aspect ratio of the screen is not 1:1, the instance
will be scaled so that it appears as if the aspect ratio
were 1:1 (i.e., so that the instances will not appear stretched).

.. rst-class:: ts-api-section

.. _InstanceModifier.ScreenSpaceStretched:

ScreenSpaceStretched
--------------------

If set, the instance will be drawn in a space that extends
from X=-1 at the left side of the screen to X=1 at the right
side of the screen and from Y=-1 at the bottom of the screen
to Y=1 at the top of the screen.

If the aspect ratio of the screen is not 1:1, the instance
will stretch in the direction of the longer side.

.. rst-class:: ts-api-section

.. _InstanceModifier.SuppressCameraScale:

SuppressCameraScale
-------------------

If set, the instance will be drawn at the same size
regardless of camera settings.

