vcApplication

Generally, a True value is used in situations where events could create cyclic calls and unintentional loops.

LayoutModified acts as a flag for determining if you are prompted to save a layout and the current state of the Save command.

The value is set to True when a user makes a change to the current layout using the GUI.

A script that makes changes to a layout should set the value to True in order for the application to know whether or not the layout needs to be saved. This is not needed if the script only makes temporary changes to a layout during a simulation.

Generally, the path is the same one you would get from the address bar of the File Explorer in Windows. For example, spaces would not be encoded as + signs.

See System.Uri.LocalPath in the .NET Framework for more information.

The URI would contain its scheme, for example a "file:///" prefix, and spaces would be encoded as + signs.

See Example. Print URI of current layout for more information.

The URI is similar to LayoutUri. One exception is a forward slash in the URI path is replaced with a backslash.

(Deprecated) Use the RecordingFileName property.

(Deprecated) Use the Recording property.

(Deprecated) Use the RecordingShow property.

(Deprecated) Use the RecordingFrameRate property.

Product classes are Creator, Configurator and Viewer.

The product version format is the major version number, minor version number and the revision number in that order separated by periods.

Caution: ProgressValue must always be set after setting ProgressStatus. Failure to do so may cause the application's GUI to enter an indefinite locked state.

Value < 0.0
Progress is unknown or stalled. Setting this value will lock the GUI and activate the progress bar.

0.0 <= Value <= 1.0
The current state of progress is within this range in which 0.0 indicates no progress and 1.0 indicates full progress. Setting this value will lock the GUI and activate progress bar.

Value > 1.0
The operation has been completed. Setting this value will unlock the GUI and deactivate the progress bar.

Caution: If ProgressValue is used to indicate the status of an operation, the set value must always be greater than 1.0 after completing the operation to unlock the application's GUI. Otherwise, the GUI may enter an indefinite locked state.

A True value means the simulation runs at a speed indicative of the real world environment. A False value means the simulations runs at speed based on the device's CPU processing speed.

See Recording Constants for more information.

A True value will start a simulation (if it was not already running) and the recording, whereas a False value will stop a simulation and the recording.

You should define other Recording properties before you start the recording. In order to stop the recording you need to set Recording to False. In cases where you are recording a 3D PDF, stopping or resetting the simulation before you set Recording to False will lose the recording and not generate a file.

Note: A recording cannot be stopped and continued without generating a new file.

A False value means the values of the RecordingHeight and RecordingWidth properties define the dimensions of a recorded video.

The default value is True. Generally, a False value is used in cases where you want to retain the current joint configuration of robots in the 3D world when teaching positions.

The effect is the same as executing the Reset button on the simulation controls.

Generally, the simulation object is used to control the execution of a simulation in the 3D world.

VREvents

vcVREvents

R

Gets VR events object of the application.

Generally, the VR events object is used for interactive Virtual Reality.

If loading is successful, the bitmap's filename is used to register the bitmap with the application.

Returns the loaded bitmap image; otherwise returns None.

By default, the bitmap is saved as a BMP file. An optional writer_info argument can be given to write the bitmap to a different format.

rbmp writes to BMP.

rjpegstd or rjpegnstd writes to JPEG.

rpng writes to PNG.

rtargareader writes to TGA.

See vcBitmap for more information.

An optional name argument can be given to find a specific camera; otherwise the method returns the first found camera.

If no camera is found, returns None.

An optional all argument of can be given to cancel all commands in the command stack or just the top-most command by giving a False value.

Loading registers a command with the given name in the application, which can be used to launch the command itself. Successful command loading returns the command as an object; otherwise, returns None.

Note: This is only for static components when simulation is not running. To clone components when a simulation is running, use vcComponent.clone().

If a physical connection requires repositioning then comp2 is snapped to comp1.

If a connection forms a parent-child hierarchy, the child component is moved and attached to the parent component.

If no match is found, returns None.

If loading is successful, returns the component; otherwise returns None.

Note: In most cases, the file URI scheme is file:/// followed by the full path to file.

Standard ids are:

Author
Component modeling

Configure
Layout configuration

Drawing
2D drawing

Teach
Robot programming.

If a layer with the given name exists, that layer is returned; otherwise the method returns the new layer. If the layer cannot be created, returns None.

See Layout Item constants for types and descriptions.

or

vcLayoutItem layout_item

If no light is found with the given name, returns None.

If the material is registered, returns True. If a material with the same name already exists, returns False.

String menu, String caption, String command, [Enum toolSize]

String siteId, [Integer position]

Adds a new site identified by siteId at the specified position.     

 siteId can be a chained string or a path,  thereby allowing you to specify a section of the user interface. For example, 'VcTabDrawing/Example' would create a new ribbon group called Example in the Drawing tab. Note: You  can refer to the UXSitesSection element of your application's configuration file to know valid IDs. Each id is an ItemId attribute of a Site element.  An optional position parameter specifies the index at  which the site should be created in its direct parent.

or

String menu, String caption, Integer position, String command

or

String menu, String caption, Integer position, String command, String tool_tip, String image, String reference_id, String control_type

or

(Deprecated)
String menu, String caption, [Integer position], String command

or

(Deprecated)
Enumeration menu, String caption, [Integer position], vcCommand command

or

(Deprecated)
Enumeration menu, String caption, [Integer position], String command

The menu argument can be a Menu Constant or id indicating the area of user interface where you want to add the menu item.

The caption argument specifies a default label for the menu item.

The command argument specifies a command by name that is executed when you interact with the menu item. For example, you can pass the name of a command registered to the application or an id that can be referenced when adding gallery menu items.

The tool_tip argument specifies a default tooltip for the menu item.

The image argument specifies the icon of the menu item.

The reference_id argument refers to another menu item by its command name or id. Generally, you would use this to add items to a gallery menu on the Ribbon in which both the gallery and its items are created using the same Python command.

The control_type argument specifies the control type of the menu item. Generally, you would use this to indicate an item as a GalleryMenuTool or GalleryMenuToolItem. If you are creating a contextual tab group in the Ribbon, you would use this to indicate a ContextualTabGroup or RibbonTab.

Each call returns an integer that is a handle for the new menu item. Use that value in the removeMenuItem() method to delete the menu item.

See Creating a Python Add-on for more information and examples.

See Template for Python Add-on for a template that can be used to quickly implement a new add-on.

(Deprecated) Use addMenuItem() method.

(Deprecated) Use addMenuItem() method.

(Deprecated) Use addMenuItem() method.

(Deprecated) Use addMenuItem() method.

or

String key_container, String key_item, String key_type

Generally, this is used to localize add-ons. If the key is not found, returns the key itself as a string.

You have two options:

1-key
Pass the entire key, for example "ComboKey::Python.MsgBoxTitle.Text".

3-key
Pass the key in three separate arguments, for example ("Python","MsgBoxTitle","Text").

The key_container argument should be "Python" if the localized string was added from Python, for example a PyResouce file associated with your Python add-on.

The key_item argument should be a unique key for the item you want to localize. For example, "printHelloLocalized.ColorPropName.red" would refer to a step value of a property named "ColorPropName" associated with a command registered to the application as "printHelloLocalized."

The key_type argument specifies the attribute of an item. For example, a command can have a label, tooltip and icon.

An item can have one or more attributes:

Text
Label for command, ribbon tab or group, message box, etc.

Name
Label for command property.

Tooltip
Tooltip for command.

Description
Tooltip for command property.

Icon
Icon for ribbon group or command. In this case, the value is the path to icon file.

<step value>
Label for step value of command property.

See Template for Python Add-on for an example on how to use this method.

The tab_id argument refers to the Id of the contextual tab group.

See Template for Python Add-on for an example.

See Creating a Python Add-on for more information and other examples.

Resetting a simulation removes all dynamic components and returns static components to their initial state at the start of a simulation.

An optional stop_time argument can be given to indicate when to stop running the simulation.

If the simulation of the application is not at its initial state, the simulation will continue from its current state. That is, the simulation clock will not reset to zero.

The name argument specifies the full name of the new quantity. The type argument specifies whether a scalar or vector quantity.

See Quantity Constants for more information.

The name argument specifies the name of the unit family and may not contain dot characters.

The name argument specifies the name of the unit group and may not contain dot characters.

Only user-created unit families can be deleted.

Only user-created unit groups can be deleted.

This method will try to match either the name or suffix of a unit to the given name.

The view itself is saved with a layout and listed as a User View in the GUI whenever the layout is loaded in the 3D world.

Defines if the clipping plane is enabled or disabled.

An optional time argument can be given to interpolate the linear movement of the camera to new view. That is, a timed camera movement (in seconds).

For example, exact copies of a conveyor with the same VCID and feature trees can be shared to consume less memory.

If you need to make a vcComponent object unique again, edit a property that affects one of its features or call its makeUnique() method.

An optional exclude argument can be given to exclude frames belonging to specific node.

Generally, this method is used to register a command used in a Python add-on.

An optional title argument can be given to define the title of the message box.

An optional type argument can given to define the box type and icon.

An optional buttons argument can be given to show a message box with buttons.

The method returns a result based on the type of message box and which button is clicked by a user.

See Message Constants for more information.

See Example on how to implement this method.

See Template for Python Add-on on how to localize a message box.

Warning: If you want to open a message box when you start the application, you should use the OnAppInitialized event to verify it is safe to generate the box.

None

or

3-tuple (vcNode hitNode, vcPolygon hitPolygon, vcMatrix hitPosition) 

or 

5-tuple (vcNode hitNode, None hitPolygon, vcMatrix hitPosition, 
vcTriangleSet hitTriangleSet, 
Integer hitTriangleIndex)

The position of the ray is based in the World coordinate system, and the length of the ray is directed along the positive Z-axis.

An optional exclude_node argument can be given to exclude a node, thereby allowing the ray to cast through and ignore collision with the given node and its child nodes.

An optional use_backface argument has a default True value to include geometry backfaces in ray casting. A False value means the ray ignores geometry backfaces.

An optional tuple argument of node, inclusion_type and inclusion scope can be given to exclude or include nodes. Excluding nodes allows the ray to cast through and ignore collision with the given nodes. Including one or more nodes will automatically exclude all the other nodes not included.

See Collision Detector Constants for more information.

If a ray collides with an object, the collision data is returned as tuple with three or five elements; otherwise returns None.

The return value tuple's elements are:

0
The vcNode object hit by the ray.

1
None or a deprecated vcPolygon object hit by the ray. If None, the tuple will have five elements.

2
The location where the ray hit as a vcMatrix object. The Z-axis is parallel with the normal of the surface hit by the ray.

3
The vcTriangleSet object hit by the ray if the second element is None.

4
The index of the triangle hit by the ray in the fourth element.

See Example on how to implement this method.

(Deprecated)

(Deprecated) Use OnAppInitialized.