Copyright © 2021 by K4.org
  (v.0.48.124)

A UIDynamicOverlay is an empty container for other controls overlaid on the geometry viewer. Add a UIDynamicOverlay-based model as a child of the geometry viewer. For positioning the overlay, specify a target point and an overlay point. The target point can be in world coordinates([[snapTargetPoint]]) or based on overlayModel model screen bounding box.

note:

The overlay must not overlap with visible geometry viewer controls, such as view cube or toolbar. If they overlap, the overlay controls will not be operational.

example

Set overlayModel to some name of the model. Set overlayModel to some name of the model and [[snapTargetAt]] to '{ x: 100, y: 100 }' to snap to right-bottom corner of the overlayModel. Set [[snapOverlayAt]] to '{ x: 100, y: 0 }' to snap to right-top corner of the overlay.Set [[snapOffset]] to '{ x: 0, y: 50 }' to add 50px vertical offset between the target snapping point and the overlay snapping point.

Index

Rules

controlType

controlType: String

Internal Use Only

Flags : Cached (Note this is uncached)

Expression : "DynamicOverlay"

hideOnClickOutside

hideOnClickOutside: Boolean

When true, the rule visibility is set to 'hidden' on clicking outside the overlay. Default is false.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

modelBoxLocation

modelBoxLocation: Any

Sets the target connector point location based on overlayModel model screen bounding box. { x: 0, y: 0 } means left-top corner, { x: 100, y: 100 } means right-bottom corner. 'x' and 'y' are in percentage of the target model bounding size. Can be negative.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : { x: 0, y: 0 }

overlayModel

overlayModel: String

If not empty then target connector point will be calculated based on the screen bounding box of the model with overlayModel.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""

screenBoxLocation

screenBoxLocation: Any

Sets the overlay connector point location based on overlay screen bounding box. { x: 0, y: 0 } means left-top corner, { x: 100, y: 100 } means right-bottom corner. 'x' and 'y' are in percentage of the overlay bounding size. Can be negative.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : { x: 0, y: 0 }

screenOffset

screenOffset: Any

The screen offset in pixels from the target connector point to overlay connector point. X-axis is from left to right on the screen. Y-axis is from top to bottom on the screen. Can be negative.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : { x: 0, y: 0 }

worldPoint

worldPoint: Point

Sets the target point in world space. This point will be projected to the screen and used to connect to the overlay connector point. Ignored if overlayModel is set.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : p(0, 0, 0)