overview

reference

elements index

# overlay-element

| namespace: | version: | branch type: | activable type: | sender type: | receiver type: | root type:
| core3d | 1.0.0. | true | true | false | true | false

The Overlay-Element define overlay components. It is possible to set severals image and text overlays at a specific position on screen. The position can be relative to the the screen size. The image switch if clicked by mouse. The text will be writable if clicked my mouse. If Overlay-element is sent a text-message if the text was clicked. The a text can change by command a text-message. The screen can have a background color (transparency do not work yet!). It must be a child of a render-element.

## default configuration:

### value: | ### type: | ### array: | ### required:
overlay:overlay-data-file | uri | yes | no
Default value:'@system/overlay/overlay.data.ctxv'
overlay:visible | bool | no | no
Default value:'true'
overlay:default-screen-size | int | yes | no
Default value:'1920, 1050'
overlay:relative-position-adjustment | bool | no | no
Default value:'true'
background:background-color | float | yes | no
Default value:'0.5, 0.5, 0.5, 1.0'
background:background-file | uri | yes | no
Default value:'background/globe.jpg'
background:background-type | string | no | no
Default value:'none'

## Commands:
dimension-event
text-command
mouse-event
text-font-command
key-event
## Events:
text-event