ImageLabel

Summary

This function allows you to attach an image to the marker.

Parameters

Image

Type: Text Default: None

This is the name of the image file to be attached to the marker. The image must be placed in the proper folder location as defined by the ARDI AR Script System.

The default location is:

<scriptname>/<file name>

Name

Type: Text Default: None

Specifies the name of the object to be added to the marker. This name can be referred to later by other scripts in order to modify and/or interact with it in some way, such as with the Remove function.

If an object of the same type has the same name, this script will modify the existing object instead of creating a new one.

Offset

Type: XYZ Coordinates Default: 0,0,0

This parameter allows you to specify the offset position of the image.

Scale

Type: XY Coordinates Default: 1,1

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

Rect

Type: Box Default: 10,10,-10,-10

This parameter allows you to specify a specific rectangle width and height as offset co-ordinates to the marker. The image will resize and re-position to fit these co-ordinates. Co-ordinates are entered as UpperLeftX,UpperLeftY,BottomRightX,BottomRightY.

Stays

Type: Boolean Default: false

This parameter will allow you to force the image to remain visible even after the following Script Step.

Facing

Type: XYZ Coordinates Default:90,0,0

This parameter allows you to specify the direction in which the Image Label is facing. Values are entered as x,y,z rotation values.

Example

  <imagelabel name="Device1Off" image="Device1/Off.png" rect="-140,-10,-120,10"/>
The above code will create an image label using the graphic file Off.png that is stored on the asset Device1. The image will be placed relative to the marker using the Box values -140,-10,-120,10, where -140,-10 is the location of the upper left corner and -120,10 is the location of the bottom right corner in relation to the marker. It will also be given the name Device1Off, which can be referenced if it needs to be removed or modified on a later part of the script.

See Also