
###################
A3DMkpViewFlagsData
###################

.. c:struct:: A3DMkpViewFlagsData

   The set of activated components in a View.
   
   In a model, a view may consist in different components:
   
   
   - Camera positioning
   - PMI Filtering
   - Geometry Filtering
   - Cross-section
   - View explosion
   - Combined State
   
   When traversing an :c:type:`~A3DMkpView` instance, you can check whether theses components are used or not by calling :c:func:`~A3DMkpViewGetFlags`\ . The returned structure is a set of boolean members which indicates the state of each component.
   
   
   Application of the component
   ============================
   
   A view's component is applied by HOOPS Exchange if:
   
   
   - It is present in the view's data,
   - The corresponding field in :c:struct:`~A3DMkpViewFlagsData` is ``A3DTrue``\ .
   
   Otherwise, the component of the current state is used if it exists, whatever the value of the field in :c:struct:`~A3DMkpViewFlagsData` is.
   
   The following array summarizes when a specific component is applied and which one:
   
   **Flag value**  \| **Defined in view**  \| **Defined in current state**  \| **Component** 
   
   
   - ``A3DTrue``  \| no  \| no  \| None
   - ``A3DTrue``  \| no  \| *yes*  \| None
   - ``A3DTrue``  \| *yes*  \| no  \| View's component
   - ``A3DTrue``  \| *yes*  \| *yes*  \| View's component
   - ``A3DFalse``  \| no  \| no  \| None
   - ``A3DFalse``  \| no  \| *yes*  \| Current component
   - ``A3DFalse``  \| *yes*  \| no  \| None
   - ``A3DFalse``  \| *yes*  \| *yes*  \| Current component
   
   For example, if within a given view, ``m_bIsCrossSectionSet == A3DTrue`` and cross-section data are present in the view then this cross-section will be used by HOOPS Exchange. This example corresponds to both third and fourth line of the table.
   
   On the other hand, if ``m_bIsCrossSectionSet == A3DFalse`` the component used will be the one defined in the current state if any. This is the case shown by the two last rows of this table.
   
   
      7.1
   
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DMkpViewFlagsData.m_bIsCameraSet`
   * :c:member:`~A3DMkpViewFlagsData.m_bIsCombineState`
   * :c:member:`~A3DMkpViewFlagsData.m_bIsCrossSectionSet`
   * :c:member:`~A3DMkpViewFlagsData.m_bIsExplosionSet`
   * :c:member:`~A3DMkpViewFlagsData.m_bIsGeomFilteringSet`
   * :c:member:`~A3DMkpViewFlagsData.m_bIsPMIFilteringSet`
   * :c:member:`~A3DMkpViewFlagsData.m_bIsSimplifiedRepresentation`
   
   



.. rst-class:: kind-group kind-variable

.. rubric:: Variables
   :class: kind-group-title


.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsCameraSet

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      A Camera is flagged on.
      
      
      



.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsPMIFilteringSet

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      PMI filtering is flagged on.
      
      
      



.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsGeomFilteringSet

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Geometry filtering is flagged on.
      
      
      



.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsCrossSectionSet

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      A Cross-section is flagged on.
      
      
      



.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsExplosionSet

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      A view explosion is flagged on.
      
      
      



.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsCombineState

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      The view is in a combined state 
      



.. c:member:: A3DBool A3DMkpViewFlagsData.m_bIsSimplifiedRepresentation

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      The view is a simplified representation.
      
      
         26.1 
      
      




