Viewport Inquiries
sd-am-inq-vp-cursor-size
sd-am-inq-vp-corners
sd-am-inq-vp-window
sd-am-inq-vp-show
sd-am-inq-reference-3d-vp
sd-am-set-reference-3d-vp
sd-am-reset-reference-3d-vp
SD-AM-INQ-VP-CURSOR-SIZE [function]
(sd-am-inq-vp-cursor-size)
- Description:
-
Returns the size of the Annotation viewport cursor in pixels.
- Return value:
- {FIXNUM} - the size in pixels of the Annotation viewport cursor
cross-hair.
SD-AM-INQ-VP-CORNERS [function]
(sd-am-inq-vp-corners)
- Description:
-
Returns the two corner points that define the Annotation viewport size
and location in screen coordinates.
- Parameters:
- Return value:
- {list of 2 GPNT2Ds} - the Annotation viewport lower-left and
upper-right corners.
SD-AM-INQ-VP-WINDOW [function]
(sd-am-inq-vp-window)
- Description:
-
Returns the two corner points that define the Annotation viewport
window.
- Parameters:
- Return value:
- {list of 2 GPNT2Ds} - the Annotation viewport window lower-left and
upper-right corners.
SD-AM-INQ-VP-SHOW [function]
(sd-am-inq-vp-show option)
- Description:
-
Inquires the show mode of Annotation objects in the Annotation viewport.
- Parameters:
-
- option - The object type to inquire the show mode for, one
of the following:
-
- :geometry - specifies geometry.
- :construction_geometry - specifies construction
geometry.
- :hidden - specifies hidden lines.
- :tangents - specifies tangent lines.
- :dimensions - specifies dimensions.
- :hatches - specifies automatic and manual hatch.
- :manual_hatches - specifies manual hatch.
- :texts - specifies texts.
- :vertices - specifies vertices.
- :update_colors - specifies AVU update colors.
- :owner - specifies highlighting of the active
owner.
- Return value:
- :on - The specified object type is shown.
- :off - The specified object type is not shown.
SD-AM-INQ-REFERENCE-3D-VP [function]
(sd-am-inq-reference-3d-vp)
- Description:
-
Returns the name of the reference 3D viewport used for drawlist
operations and for viewport direction definitions.
- Return value:
- {STRING} - the 3D viewport name.
SD-AM-SET-REFERENCE-3D-VP [function]
(sd-am-set-reference-3d-vp vport)
- Description:
-
Sets the name of the reference 3D viewport used for drawlist operations
and for viewport direction definitions. If no reference 3D viewport is
specified or the current reference 3D viewport does not exist any more,
then the drawlist and the viewport directions of a randomly selected 3D
viewport are taken as reference, when an auxiliary or 3D viewport is
opened.
- Parameters:
-
vport {STRING} - the name of the 3D reference viewport.
- Return value:
- t - success
- nil - failure
SD-AM-RESET-REFERENCE-3D-VP [function]
(sd-am-reset-reference-3d-vp)
- Description:
-
Resets the reference 3D viewport for drawlist and viewport directions.
Afterwards no specific reference 3D viewport is defined.
- Return value:
- t - success
- nil - failure
© 2023 Parametric
Technology GmbH
(a subsidiary of PTC Inc.), All Rights Reserved |