AddImage

Summary

This function allows you to add an Image to the user interface. By default, the image can be moved around by clicking and dragging on it or it can be removed by pressing on the cross at the top right of the image. Both of these features are optional and can be removed with the use of associated parameters.

Parameters

Image

Type: Text Default: None

This is the name of the image file to be added to the user interface. The image must be placed in the proper folder location as defined by the ARDI VE System.

The default location is:

C:\users\<username>\documents\Optrix\ARDI\<scene name>\scripts

Where <username> is your windows username and <scene name> is the name of the scene being loaded from within ARDI VE.

Name

Type: Text Default: None

This parameter allows you to give the image a name which can then be referred to by other functions to interact with it, such as the RemoveImage function.

CanBeMoved

Type: Boolean Default: True

This parameter allows you to click and drag the image around the screen. If set to false, the image will become static and immovable.

CanBeClosed

Type: Boolean Default: True

This parameter allows you to remove an image by pressing the 'cross' button that appears on the top right corner of the image. If set to false, no cross button will appear and the image can only be removed from separate removal functions such as RemoveImage.

Width

Type: Float Default: 300

This parameter allows you to specify the width of the image.

Height

Type: Float Default: 300

This parameter allows you to specify the height of the image.

Fullscreen

Type: Boolean Default: False

This parameter allows you to fill the screen with the image. If true, the width and height parameters will be ignored and the image will be stretched to cover the entire screen.

See Also

Examples

<addimage Image="House.png" Name="House" />
<addimage Image="Sunset.png" Name="Sunset" CanBeMoved="False" CanBeClosed="False" />
This code adds 2 images to the screen, House.png named House and Sunset.png named Sunset.
The user will be able to click and drag the House image to move it around the screen and position as they see fit. They can also click on the cross icon at the top right of it to remove it. The Sunset image however will be unable to be moved or removed.
<removeimage Name="Sunset" />
This code will search for the image named Sunset as defined by the Name parameter. It will then remove it from the user interface.