Documentation Center

Viz Arc Script Guide

Version 1.9 | Published October 31, 2023 ©

Control Object Classes

After having accessed the action holding the list of ControlObjects thought the GetAction method, the single ControlObjects can be retreived using the global method

  • BaseControlObject GetControlObject( BaseAction action, string ControlObjectID )


Most Control Object types have the following generic properties:

  • Text (String)

    • This property adapts to all objects (execute string)

    • IntControl.Text = "5"

    • ImageControl.Text = "IMAGE*FolderA/SubfolderB/ImageName"

  • ID (String)

    • Returns ObjectID

  • Description

    • Returns the object description

Each Control Object type has specific properties:

Control Container

Properties:

  • Visibility

  • Position

    • posX (double)

    • posY (double)

    • posZ(double)

  • Rotation

    • rotX (double)

    • rotY (double)

    • rotZ (double)

  • Scaling

    • scaX (double)

    • scaY (double)

    • scaZ (double)

This type doesn’t have the Text property.

Control Image

Properties:

  • Path (string)

  • Position

    • posX (double)

    • posY (double)

  • Scaling

    • scaX (double)

    • scaY (double)

Control Material

Properties:

  • Path (string)

Control Omo

Properties:

  • Value (integer)

Control Text

Properties:

  • Value (string)

Control List

Example:

sub OnInit()
'declare variables
dim objAction, table, cell
dim output1, output2, output3
'get table obj action
objAction = arc.GetAction("object")
table = arc.GetControlObject (objAction, "controlObj_ID")
Console.WriteLine("Table name: " & table.Text)
'set values in single cells inside the table
table(0,0).value = false
table(0,1).value = 5
table(2,5).x = 12
table(3,6).value = "IMAGE*/Default/GER"
'assign values to a variable and show in debug console
output1 = table(0,0).Text
output2 = table(0,1).Text
output3 = table(0,2).Text
Console.WriteLine("cell - " & output1 & " | " & output2 & " | " & output3)
end sub

Properties:

  • Accessor

    • table[int row, int col]
      returns a cell

    • nbcolumns (integer)
      number of columns

    • nbrows (integer)
      numbers of rows

Single Cells Properties

Cell

Type

Additional Information

Example

BaseCell

Text (string)

Sets or gets value as string.
Common to every cell type.

table(0,5).x= 12 (intCell)
table(0,5).text = "12" (intCell)

BoolCell

Value (boolean)


table(0,5).active= true

DoubleCell

Value (double) 


table(0,5).x= 12.8

DupletCell

X (double)
Y (double) 


table(0,5).text = "0.55 0.2"

GeomCell

Value (string) 


table(0,5).value = "GEOM*/folder/geometry"

ImageCell

Value (string) 


table(0,5).value = "IMAGE*/folder/image"

IntCell

Value (integer)



MaterialCell

Value (string) 


table(0,5).value = "MATERIAL*/folder/material"

TextCell

Value (string)



TripletCell

X (double)
Y (double)
Z (double) 


table(0,5).text = "0.55 0.23 1.23"

Control Integer

Properties:

  • Value (integer)

Control Double

Properties:

  • Value (double)

Control Boolean

Properties:

  • Value (boolean)