.. role:: clio-deprecated
   :class: clio-flag clio-flag-deprecated


###################################
A3DPDFCheckBoxSetForFitSelectedMode
###################################

.. c:function:: A3DStatus A3DPDFCheckBoxSetForFitSelectedMode(A3DPDFCheckBox *pCheckBox, A3DPDF3DAnnot *p3DAnnot)

   .. rst-class:: clio-flags
   
      :clio-deprecated:`deprecated`
   
   .. rst-class:: sig-pretty-signature
   
      | :c:enum:`~A3DStatus` A3DPDFCheckBoxSetForFitSelectedMode(:c:type:`~A3DPDFCheckBox`\ \* **pCheckBox**\ , :c:type:`~A3DPDF3DAnnot`\ \* **p3DAnnot**\ )
   
   This function makes the check box field be the selector for the 'zoom on behaviour' at selection mode of the annot 3D.
   
   
   .. warning::
   
      This function is deprecated. Please use :c:func:`~A3DPDFCheckBoxSetForZoomOnBehaviour` with behaviour kA3DPDFDataSelect instead. This will be removed in version 2028.1.0. If the end-user checks the check box, the 'zoom on behaviour' at selection mode is on ; else it is off.
   
   
   This function provides a way for the end-user to control the 'zoom on behaviour' at selection mode for an annot 3D. With it, a check box field can be associated to an annot 3D. If the end-user checks the box, all selections made on the 3D annot are followed by a zoom action, i.e. the camera is zoomed to the selected node. This mode is only available when interactivity is defined using datamodel and the :c:enumerator:`~kA3DPDFDataSelect` target behaviour. An example is a scenario where you have a scroll table associated to an annot 3D, with the target behaviour :c:enumerator:`~kA3DPDFDataSelect`\ . When the end-user selects a row in the scroll table, the corresponding node is selected in the 3D annot. Then, if the check box for 'zoom on behaviour' at selection mode is checked, the camera zooms to the node. If the check box is not checked, there is no camera zoom.
   
   **Return Values**
   
   
      **A3D_SUCCESS**\ :
   
   
   
      13.1
   
   
   **Parameters**
   
   
      **pCheckBox**\ : The CheckBox object to work on.
   
      **p3DAnnot**\ : The Annot 3D to work on.
   
   
   **Returns**
   
   
      A3D_SUCCESS in case of success or an error code
   
   




