realvirtual.io

https://realvirtual.io/apidoc/
Admin
realvirtual.io is an industrial automation framework that provides a comprehensive class reference...
Tokens:26,105
Snippets:288
Trust Score:5.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### IInitStart Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for initialization actions during the start phase.

```APIDOC
IInitStart:
  description: Interface for initialization actions during the start phase.
```

--------------------------------

### Environment and Controller Components

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for components related to environment setup and control, including EnvironmentController, EvironmentSetup, and FloorSetup.

```APIDOC
EnvironmentController:
  (No detailed description available)

EvironmentSetup:
  (No detailed description available)

FloorSetup:
  (No detailed description available)
```

--------------------------------

### StartDriveOnCondition Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Automatically starts a drive based on monitoring other drive positions or sensor states. This class enables conditional activation of movement sequences in automation systems.

```APIDOC
class realvirtual.StartDriveOnCondition
  StartDriveOnCondition automatically starts a drive based on monitoring other drive positions or sensor states.
  [More...](https://realvirtual.io/apidoc/classrealvirtual_1_1_start_drive_on_condition.html#details)
```

--------------------------------

### Open Demo Scene Functions

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Static functions to open various demo scenes, showcasing different functionalities like radial, guided transport, CAM, robot IK, and more.

```APIDOC
static void OpenDemoScene()
static void OpenDemoRadial()
static void OpenDemoGuidedTransport()
static void OpenDemoCAM()
static void OpenDemoChangeMU()
static void OpenDemoChain()
static void OpenDemoRoboDK()
static void OpenDemoStartingDrives()
static void OpenDemoGripping()
static void OpenDemoMovingTransportSurface()
static void OpenDemoForceDrive()
static void OpenDemoRaycastDrive()
static void OpenDemoRobotIK()
static void OpenDemoRobotPerformance()
static void OpenDemoGuidedLoading()
```

--------------------------------

### DebugWriteAwakeEnableStart Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

A debug component that logs Unity lifecycle events (Awake, OnEnable, Start) for troubleshooting script execution order. This class aids in understanding the sequence of script initializations.

```APIDOC
class DebugWriteAwakeEnableStart:
  description: Debug component that logs Unity lifecycle events (Awake, OnEnable, Start) for troubleshooting script execution order.
```

--------------------------------

### KinematicMU Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides physics-based transport of material units on guided surfaces with automatic path following and transitions.

```APIDOC
class realvirtual.KinematicMU
  Enables physics-based transport of material units on guided surfaces with automatic path following and transitions.
```

--------------------------------

### GuidedMU Movement

Source: https://realvirtual.io/apidoc/namespacerealvirtual

GuidedMU enables Material Unit (MU) objects to follow guided transport surfaces using physics constraints.

```APIDOC
class realvirtual.GuidedMU:
  description: GuidedMU enables MU (material unit) objects to follow guided transport surfaces using physics constraints.
```

--------------------------------

### QuickEditMenuItem Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

The class automatically saves the scene when run is started in the Unity editor. It can be turned off by the toggle in the realvirtual menu.

```APIDOC
QuickEditMenuItem:
  Description: The class is automatically saving the scene when run is started in the Unity editor. It can be turned off by the toggle in the realvirtual menu.
```

--------------------------------

### LightingSettingsInitializer Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Initializes lighting settings.

```APIDOC
class realvirtual.LightingSettingsInitializer
  Initializes lighting settings.
```

--------------------------------

### SelectionWindowSettings Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Contains settings and configuration options for the SelectionWindow.

```APIDOC
class realvirtual::SelectionWindowSettings
  # Documentation for the SelectionWindowSettings class.
  # More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_selection_window_settings.html
```

--------------------------------

### LogicStep_Enable Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Logic step that enables or disables a GameObject and immediately proceeds.

```APIDOC
class realvirtual.LogicStep_Enable
  Logic step that enables or disables a GameObject and immediately proceeds.
```

--------------------------------

### LogicStep Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Base class for all logic steps that define sequential or parallel automation logic in realvirtual.

```APIDOC
class realvirtual.LogicStep
  Base class for all logic steps that define sequential or parallel automation logic in realvirtual.
```

--------------------------------

### CameraPositionEditor - CameraPosition Editor

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Editor class for Get Position and SetPosition methods of CameraPosition. Provides custom inspector functionality for managing camera positions in the Unity editor.

```APIDOC
CameraPositionEditor:
  Description: Editor class for Get Position and SetPosition of CameraPosition.
  Details: https://realvirtual.io/apidoc/classrealvirtual_1_1_camera_position_editor.html#details
```

--------------------------------

### GuideCircle Path Guidance

Source: https://realvirtual.io/apidoc/namespacerealvirtual

GuideCircle provides circular path guidance for movement systems.

```APIDOC
class realvirtual.GuideCircle:
  description: GuideCircle provides circular path guidance for movement systems.
```

--------------------------------

### IGuide Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for path guidance components in material transport systems.

```APIDOC
IGuide:
  description: IGuide defines the interface for path guidance components in material transport systems.
```

--------------------------------

### realvirtual.io API Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

This section details the classes and their functionalities within the realvirtual.io library. It includes descriptions for Pattern, PerformanceOptimizer, PixyzImporter, and various PLC input/output signals.

```APIDOC
PathStrategy:
  Description: Represents a path strategy.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_path_strategy.html

Pattern:
  Description: Pattern component for generating arrays of GameObjects in circular or matrix configurations.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_pattern.html

PerformanceOptimizer:
  Description: Dramatically improves runtime performance by intelligently combining static meshes into optimized batches.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_performance_optimizer.html

Persistence:
  Description: Represents persistence functionalities.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_persistence.html

PixyzImporter:
  Description: Helper to import CAD Data with PIXYZ into realvirtual. Needs to be used together with CADUpdater.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_pixyz_importer.html

PlannerAttributes:
  Description: Represents planner attributes.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_planner_attributes.html

PlayGroupWindow:
  Description: Represents the PlayGroupWindow.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_play_group_window.html

PLC_BoxConveyor:
  Description: PLC Script for the realvirtual demo model.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c___box_conveyor.html

PLC_CanConveyor:
  Description: PLC Script for the realvirtual demo model.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c___can_conveyor.html

PLC_Handling:
  Description: PLC Script for the realvirtual demo model.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c___handling.html

PLC_Robot:
  Description: PLC Script for the realvirtual demo model.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c___robot.html

PLCDemoCNCLoadUnload:
  Description: Represents the PLCDemoCNCLoadUnload functionality.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_demo_c_n_c_load_unload.html

PLCInputBool:
  Description: PLC Boolean Input Signal - Represents a boolean input signal from PLC to simulation.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_input_bool.html

PLCInputFloat:
  Description: PLC Float Input Signal - Represents a floating-point input signal from PLC to simulation.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_input_float.html

PLCInputInt:
  Description: PLC Integer Input Signal - Represents a 32-bit integer input signal from PLC to simulation.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_input_int.html

PLCInputText:
  Description: PLC BOOL INPUT Signal.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_input_text.html

PLCInputTransform:
  Description: PLC INT INPUT Signal.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_input_transform.html

PLCOutputBool:
  Description: PLC Boolean Output Signal - Represents a boolean output signal from simulation to PLC.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_output_bool.html

PLCOutputFloat:
  Description: PLC Float Output Signal - Represents a floating-point output signal from simulation to PLC.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_output_float.html

PLCOutputInt:
  Description: PLC Integer Output Signal - Represents a 32-bit integer output signal from simulation to PLC.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_output_int.html

PLCOutputText:
  Description: PLC INT Output Signal.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_output_text.html

PLCOutputTransform:
  Description: Represents PLC Transform Output Signal.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_p_l_c_output_transform.html
```

--------------------------------

### LogicMove3AxisPickAndPlace Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Controls a 3-axis pick and place automation sequence using three drives.

```APIDOC
class realvirtual.LogicMove3AxisPickAndPlace
  Controls a 3-axis pick and place automation sequence using three drives.
```

--------------------------------

### NetworkInitializer Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Initializes and manages networked components for collaborative multi-user simulation environments.

```APIDOC
class realvirtual.NetworkInitializer
  Initializes and manages networked components for collaborative multi-user simulation environments.
```

--------------------------------

### LogicStep_CinemachineCamera Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Logic step for controlling Cinemachine cameras.

```APIDOC
class realvirtual.LogicStep_CinemachineCamera
  Logic step for controlling Cinemachine cameras.
```

--------------------------------

### GuideLine Path Guidance

Source: https://realvirtual.io/apidoc/namespacerealvirtual

GuideLine provides linear path guidance for movement systems.

```APIDOC
class realvirtual.GuideLine:
  description: GuideLine provides linear path guidance for movement systems.
```

--------------------------------

### Signal and Interface Classes

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for signal and interface classes, including EthernetIPSignal and FanucInterface.

```APIDOC
EthernetIPSignal:
  (No detailed description available)

FanucInterface:
  (No detailed description available)
```

--------------------------------

### QuickEdit Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Legacy adapter for old QuickEdit references. Provides backward compatibility for scripts that used the old QuickEdit system.

```APIDOC
QuickEdit:
  Description: Legacy adapter for old QuickEdit references. This provides backward compatibility for scripts that used the old QuickEdit system.
```

--------------------------------

### Utility Functions

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Utility functions for general operations such as opening documentation and retrieving information.

```APIDOC
static void OpenDocumentation()
static void Info()
```

--------------------------------

### Lamp_Connection Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Handles PLC Inputs and Outputs for a Lamp component.

```APIDOC
class realvirtual.Lamp_Connection
  PLC Inputs and Outputs for a Lamp. Can be added to the Lamp component.
```

--------------------------------

### LODGeneratorHelper Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

A helper class for the LOD generator.

```APIDOC
class realvirtual.LODGeneratorHelper
  A LOD (level of detail) generator helper.
```

--------------------------------

### Lamp Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

A lamp component for creating visual status indicators in industrial automation simulations.

```APIDOC
class realvirtual.Lamp
  Lamp component for creating visual status indicators in industrial automation simulations.
```

--------------------------------

### realvirtual::SettingsSignal Struct

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Configuration settings for signals, including activation status, flank detection, and override options.

```APIDOC
realvirtual::SettingsSignal:
  Active: bool
  DetectBoolFlanks: bool
  Override: bool
```

--------------------------------

### LogicStep_SerialContainer Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Logic step container that executes child logic steps sequentially.

```APIDOC
class realvirtual.LogicStep_SerialContainer
  Logic step container that executes child logic steps sequentially.
```

--------------------------------

### LODGenerator Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Contains methods for generating LODs (level of details) for game objects.

```APIDOC
class realvirtual.LODGenerator
  Contains methods for generating LODs (level of details) for game objects.
```

--------------------------------

### IInitEnable Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for initialization actions during the enable phase.

```APIDOC
IInitEnable:
  description: Interface for initialization actions during the enable phase.
```

--------------------------------

### SimpleJoint Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

SimpleJoint simplifies the configuration of Unity physics joints, specifically tailored for industrial automation simulations.

```APIDOC
SimpleJoint:
  Description: SimpleJoint streamlines Unity physics joint configuration for industrial automation simulations.
  Details: https://realvirtual.io/apidoc/classrealvirtual_1_1_simple_joint.html#details
```

--------------------------------

### Interface and Component Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for various interfaces and components used in the realvirtual.io system, including communication interfaces like EthernetIPInterface, utility components like Fixer, and physics-related components like ForceDrive.

```APIDOC
EthernetIPInterface:
  EtherNet/IP interface for communication with Allen-Bradley/Rockwell Automation PLCs and other CIP-enabled devices.

Fixer:
  Fixer component for securing MUs to specific positions or surfaces in the automation system.

ForceDrive:
  Moves Rigidbodies based on joints and forces.
```

--------------------------------

### LogicStep_DriveTo Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Logic step that moves a drive to a specified target position and waits for completion.

```APIDOC
class realvirtual.LogicStep_DriveTo
  Logic step that moves a drive to a specified target position and waits for completion.
```

--------------------------------

### MaterialWindow

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Class to handle the creation of the realvirtual menu. Manages the user interface elements for material selection or configuration.

```APIDOC
MaterialWindow:
  description: Class to handle the creation of the realvirtual menu.
  details: https://realvirtual.io/apidoc/classrealvirtual_1_1_material_window.html
```

--------------------------------

### LightGroup Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Manages centralized control of multiple lights.

```APIDOC
class realvirtual.LightGroup
  The LightGroup is used to be able to set centralized multiple lights.
```

--------------------------------

### BaseStation Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BaseStation class, which provides intelligent workstation control for path-based material handling systems. It details the functionalities for managing workstations in automated environments.

```APIDOC
BaseStation:
  BaseStation provides intelligent workstation control for path-based material handling systems.
  See more at: https://realvirtual.io/apidoc/classrealvirtual_1_1_base_station.html#details
```

--------------------------------

### Runtime Tooltip Functionality

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides runtime tooltip functionality for 3D objects with automatic collider generation.

```APIDOC
class RuntimeTooltip(https://realvirtual.io/apidoc/classrealvirtual_1_1_runtime_tooltip.html)
  """Provides runtime tooltip functionality for 3D objects with automatic collider generation."""

```

--------------------------------

### Hotkeys API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

API for managing hotkeys.

```APIDOC
Hotkeys:
  description: API for managing hotkeys.
```

--------------------------------

### realvirtual.io UI and Transport Classes

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for UI elements and transport system classes in the realvirtual namespace.

```APIDOC
ThreeMFPart:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_three_m_f_part.html

ToggleButton:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_toggle_button.html

ToolbarLogoButton:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_toolbar_logo_button.html

ToolbarScaler:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_toolbar_scaler.html

TransportSurface:
  Simulates conveyor belts and transport systems for moving objects through industrial automation processes.
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_transport_surface.html#details

TransportsurfaceCollider:
  The drive is moving components including all sub components along the local axis of the game object.
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_transportsurface_collider.html#details

TransportSurfaceDriveHierarchyRule:
  Validates that TransportSurface components don't have more than one Drive component above them in the hierarchy.
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_transport_surface_drive_hierarchy_rule.html#details
```

--------------------------------

### SceneDescriptionSO Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Represents a ScriptableObject (SO) for scene descriptions, potentially used for data-driven scene configuration.

```APIDOC
class realvirtual::SceneDescriptionSO
  # Documentation for the SceneDescriptionSO class.
  # More details available at: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_scene_description_s_o
```

--------------------------------

### IBeforeAwake Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for actions to be performed before awake.

```APIDOC
IBeforeAwake:
  description: Interface for actions to be performed before awake.
```

--------------------------------

### IInitAwake Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for initialization actions during the awake phase.

```APIDOC
IInitAwake:
  description: Interface for initialization actions during the awake phase.
```

--------------------------------

### Drive Utility and Control Classes

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for classes related to drive handling, recording, and visualization. This includes DriveHandle for editor interaction, DrivesRecorder and DrivesRecording for data logging, and DriveVisu for visualization purposes.

```APIDOC
DriveHandle:
  Class for displaying the drive handle in Unity Editor in Scene View during edit and play mode. With the drive handle the drive directions can be defined and the drive can moved manually during playmode.

DrivesRecorder:
  (No detailed description available)

DrivesRecording:
  (No detailed description available)

DriveVisu:
  (No detailed description available)
```

--------------------------------

### LODBackupComponent Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Component for Level of Detail (LOD) backup.

```APIDOC
class realvirtual.LODBackupComponent
  Component for Level of Detail (LOD) backup.
```

--------------------------------

### UnFixer Component

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Releases fixed MUs (Manufacturing Units) back to physics simulation, allowing for free movement after being constrained.

```APIDOC
class UnFixer:
  """UnFixer component releases fixed MUs back to physics simulation for free movement."""
  pass
```

--------------------------------

### APIDOC: SignatureAlgorithm Enumeration

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Lists the supported signature algorithms, including SHA variants and RSA padding schemes.

```APIDOC
enum SignatureAlgorithm {
  Sha1,
  Sha256,
  Rsa15,
  RsaOaep,
  RsaOaep256,
  RsaPss256
}
```

--------------------------------

### realvirtual::SceneDescription Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Defines a scene with its associated asset bundle, description, display name, icon, and scene name.

```APIDOC
realvirtual::SceneDescription:
  assetBundle: string
  Description: string
  DisplayName: string
  SceneIcon: Texture2D
  sceneName: string
```

--------------------------------

### HMI_DropDown API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

HMI prefab to generate a drop down menu with a list of options.

```APIDOC
HMI_DropDown:
  description: HMI prefab to generate a drop down menu with a list of options.
```

--------------------------------

### realvirtual::GroupSettings Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Configuration settings for groups, controlling activation, visibility, and initial state. Used for managing collections of objects.

```APIDOC
realvirtual::GroupSettings:
  Active: bool
    Description: Whether the group is active.
  DisableGameObjectOnHide: bool = true
    Description: Whether to disable the GameObject when the group is hidden.
  DisableMeshOnHide: bool
    Description: Whether to disable the mesh when the group is hidden.
  GroupName: string
    Description: The name of the group.
  InactiveOnStart: bool = true
    Description: Whether the group should be inactive on start.
```

--------------------------------

### Line Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Implements straight-path segments for building complex material transport networks in automation systems.

```APIDOC
class realvirtual.Line
  Line implements straight-path segments for building complex material transport networks in automation systems.
```

--------------------------------

### IGuidedSurface Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for transport surfaces that provide path guidance for material units.

```APIDOC
IGuidedSurface:
  description: IGuidedSurface defines the contract for transport surfaces that provide path guidance for material units.
```

--------------------------------

### realvirtual.io Interaction and Transport Classes

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for interaction and transport system classes in the realvirtual namespace.

```APIDOC
TooltipController:
  Controls the display of tooltips when hovering over objects with RuntimeTooltip components.
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_tooltip_controller.html#details

TouchInteraction:
  Controls touch interaction during game4automation simulation / play mode.
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_touch_interaction.html#details

TransportGuided:
  Creates guided transport paths for MUs with automatic path following.
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_transport_guided.html#details
```

--------------------------------

### BlurSettings Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BlurSettings class, which encapsulates the configuration parameters for blur effects. This allows customization of blur intensity, radius, and other visual properties.

```APIDOC
BlurSettings:
  See more at: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_blur_settings
```

--------------------------------

### SimulinkInterface Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides a shared memory interface for integration with Siemens Simit shared memory structures. This class facilitates communication between simulation environments and external systems using Simit's memory layout.

```APIDOC
class realvirtual.SimulinkInterface
  Shared memory interface for an interface based on Siemens Simit shared memory structure (see Simit documentation).
  [More...](https://realvirtual.io/apidoc/classrealvirtual_1_1_simulink_interface.html#details)
```

--------------------------------

### Editor Gizmo Options

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the EditorGizmoOptions class, used for configuring gizmo behavior in the Unity Editor.

```APIDOC
EditorGizmoOptions:
  (No detailed description available)
```

--------------------------------

### realvirtual.io TextTimer and TextTransportData

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for TextTimer and TextTransportData classes in the realvirtual namespace.

```APIDOC
TextTimer:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_text_timer.html

TextTransportData:
  URL: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_text_transport_data
```

--------------------------------

### PrefabGenerator Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Automates the creation of optimized prefabs with embedded mesh assets for efficient industrial model management.

```APIDOC
PrefabGenerator:
  Description: Automates creation of optimized prefabs with embedded mesh assets for efficient industrial model management.
```

--------------------------------

### realvirtual.io TwinCatAdsInterface Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the TwinCatAdsInterface class in the realvirtual namespace.

```APIDOC
TwinCatAdsInterface:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_twin_cat_ads_interface.html
```

--------------------------------

### HMI_Pushbutton API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Industrial pushbutton HMI component with PLC signal integration and multi-state visual feedback.

```APIDOC
HMI_Pushbutton:
  description: Industrial pushbutton HMI component with PLC signal integration and multi-state visual feedback.
```

--------------------------------

### realvirtual::SceneDescriptionSO Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Scriptable Object for Scene Description, holding scene metadata like asset bundle, description, display name, icon, and scene name.

```APIDOC
realvirtual::SceneDescriptionSO:
  assetBundle: string
  Description: string
  DisplayName: string
  SceneIcon: Texture2D
  sceneName: string
```

--------------------------------

### Gripper Component

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Gripper component providing complete gripping functionality for robotic pick-and-place operations.

```APIDOC
class realvirtual.Gripper:
  description: Gripper component providing complete gripping functionality for robotic pick-and-place operations.
```

--------------------------------

### IKTarget Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Defines precise robot target positions with industrial motion parameters for accurate path execution.

```APIDOC
class IKTarget
  description: Defines precise robot target positions with industrial motion parameters for accurate path execution.
  link: https://realvirtual.io/apidoc/classrealvirtual_1_1_i_k_target.html
```

--------------------------------

### LogicStep_ParallelContainer Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Logic step container that executes all child logic steps in parallel.

```APIDOC
class realvirtual.LogicStep_ParallelContainer
  Logic step container that executes all child logic steps in parallel.
```

--------------------------------

### MathHelper

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Math helpers. Provides utility functions for mathematical operations.

```APIDOC
MathHelper:
  description: Math helpers.
  details: https://realvirtual.io/apidoc/classrealvirtual_1_1_math_helper.html
```

--------------------------------

### IKPath Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Orchestrates complex robotic motion sequences through target-based path planning with industrial interpolation modes.

```APIDOC
class IKPath
  description: Orchestrates complex robotic motion sequences through target-based path planning with industrial interpolation modes.
  link: https://realvirtual.io/apidoc/classrealvirtual_1_1_i_k_path.html
```

--------------------------------

### Specialized Drive and Controller Components

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for specialized drive and controller components, such as DrivePulseEncoder, EmergencyButton3D, and FirstPersonController.

```APIDOC
DrivePulseEncoder:
  (No detailed description available)

EmergencyButton3D:
  (No detailed description available)

FirstPersonController:
  (No detailed description available)
```

--------------------------------

### Sound Component Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides audio feedback for automation components. The Sound class allows for the integration of sound effects or alerts to enhance the user experience and provide auditory cues during simulation.

```APIDOC
class realvirtual.Sound
  Sound provides audio feedback for automation components.
  [More...](https://realvirtual.io/apidoc/classrealvirtual_1_1_sound.html#details)
```

--------------------------------

### WandelbotsNOVAInterface

Source: https://realvirtual.io/apidoc/namespacerealvirtual

An interface for interacting with the Wandelbots NOVA API, enabling control and communication with Wandelbots robots.

```APIDOC
class WandelbotsNOVAInterface:
  """WandelbotsNOVAInterface is an Interface for the Wandelbots NOVA API."""
  pass
```

--------------------------------

### SceneManagement Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Handles the management of scenes within the RealVirtual application, including loading, unloading, and switching between scenes.

```APIDOC
class realvirtual::SceneManagement
  # Documentation for the SceneManagement class.
  # More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_scene_management.html
```

--------------------------------

### BehaviorInterface Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BehaviorInterface class, the base class for all behavior models that have connections to PLC signals. It defines the interface for integrating PLC logic with simulation behaviors.

```APIDOC
BehaviorInterface:
  Base class for all behavior models with connection to PLC signals.
  See more at: https://realvirtual.io/apidoc/classrealvirtual_1_1_behavior_interface.html#details
```

--------------------------------

### SelectionWindow Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Represents a UI window used for displaying and managing selections.

```APIDOC
class realvirtual::SelectionWindow
  # Documentation for the SelectionWindow class.
  # More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_selection_window.html
```

--------------------------------

### Logger Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Static logging class for the realvirtual framework with automatic hierarchy path inclusion.

```APIDOC
class realvirtual.Logger
  Static logging class for realvirtual framework with automatic hierarchy path inclusion.
```

--------------------------------

### Drive Behavior Models

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for various drive behavior models, detailing their specific functionalities and use cases within the realvirtual.io system. This includes models for following positions, gear-driven movements, speed control, and sequential operations.

```APIDOC
Drive_FollowPosition:
  Behavior model of a drive where the drive is exactly following the current given position of the PLC. This is special useful for connecting motion controllers and robot controllers to realvirtual.

Drive_Gear:
  Behavior model of a drive which is connected to another drive with a gear.

Drive_MeasureSpeedPosition:
  Behavior model of a cylinder movement which can be connected to a Drive.

Drive_Sequence:
  Defines sequentially movement of drives which can set signals or be started by signals.

Drive_Simple:
  Drive_Simple provides basic bidirectional control for Drive components with PLC integration.

Drive_Speed:
  Behavior model of an intelligent drive which is getting a destination and moving to the destination.
```

--------------------------------

### realvirtualController Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

This object must be in every realvirtual scene. It controls main central data (like scale) and manages main realvirtual settings for the scene.

```APIDOC
realvirtualController:
  Description: This object needs to be in every realvirtual scene. It controls main central data (like scale...) and manages main realvirtual settings for the scene.
```

--------------------------------

### SceneInfo Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides information about a scene, such as its name, path, or other relevant metadata.

```APIDOC
class realvirtual::SceneInfo
  # Documentation for the SceneInfo class.
  # More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_scene_info.html
```

--------------------------------

### LogicStep_Delay Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Logic step that introduces a time delay before proceeding to the next step.

```APIDOC
class realvirtual.LogicStep_Delay
  Logic step that introduces a time delay before proceeding to the next step.
```

--------------------------------

### BaseSource Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BaseSource class, the foundational class for all Source objects within the realvirtual system. It defines the common properties and methods for data sources.

```APIDOC
BaseSource:
  This is the base class for all realvirtual Source objects.
  See more at: https://realvirtual.io/apidoc/classrealvirtual_1_1_base_source.html#details
```

--------------------------------

### Move Pivot Tool and Functionality

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides tools and shared content for manipulating the pivot point of objects, including entry points for pivot manipulation and dockable window interfaces.

```APIDOC
class realvirtual.MovePivotTool
  // Move Pivot Tool - Entry point for pivot manipulation functionality.
  // More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_move_pivot_tool.html#details

class realvirtual.MovePivotToolContent
  // Shared content for Move Pivot Tool - used by both overlay and window modes.
  // More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_move_pivot_tool_content.html#details

class realvirtual.MovePivotWindow
  // Move Pivot dockable window - provides pivot manipulation in a standard Unity window.
  // More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_move_pivot_window.html#details
```

--------------------------------

### RoboDK Integration and Automation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides the link to create macros and automate RoboDK. This class serves as the primary interface for interacting with RoboDK functionalities.

```APIDOC
class RoboDK:
  """This class is the link to allows to create macros and automate Robodk."""

```

--------------------------------

### realvirtual::meshGizmo Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides gizmo functionality for meshes, controlling visibility of mesh centers, pivots, and mesh lists. Used for debugging and visualization.

```APIDOC
realvirtual::meshGizmo:
  DrawMeshCenter: bool
    Description: Whether to draw the mesh center.
  DrawMeshPivot: bool
    Description: Whether to draw the mesh pivot.
  mainGO: GameObject
    Description: The main GameObject associated with the gizmo.
  MeshColor: Color
    Description: The color of the mesh gizmo.
  meshFilterList: List<MeshFilter>
    Description: A list of MeshFilters to apply the gizmo to.
  pivotSize: float
    Description: The size of the pivot.
```

--------------------------------

### OPCUAInterfaceEditor Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

OPCUAInterface Editor class for the Unity Inspector window.

```APIDOC
class realvirtual.OPCUAInterfaceEditor
  OPCUAInterface Editor class for the Unity Inspector window.
```

--------------------------------

### SceneSelectionManager - Interactive Object Selection

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Manages interactive object selection and highlighting in 3D scenes. It supports multi-layer visual feedback systems for runtime selection.

```APIDOC
class realvirtual::SceneSelectionManager
  # Manages interactive object selection and highlighting in 3D scenes with multi-layer visual feedback systems.
  # More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_scene_selection_manager.html
```

--------------------------------

### IAllScenesLoaded Interface API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for when all scenes are loaded.

```APIDOC
IAllScenesLoaded:
  description: Interface for when all scenes are loaded.
```

--------------------------------

### realvirtual::RecordingHandle Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Manages recording handles, likely for tracking data over time. It includes properties for current index, drive IDs, recorder instances, and frame information.

```APIDOC
realvirtual::RecordingHandle:
  Currentindex: int
  driveid: Hashtable
  DrivesRecorder: DrivesRecorder
  Frame: int (Defaults to 0)
  iddrive: Hashtable
```

--------------------------------

### HMI_Controller API

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Centralizes camera control and interaction management for industrial HMI systems with multi-view capabilities.

```APIDOC
HMI_Controller:
  description: Centralizes camera control and interaction management for industrial HMI systems with multi-view capabilities.
```

--------------------------------

### BaseSensor Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BaseSensor class, serving as the base class for all Sensor objects in the realvirtual system. It outlines the common interface for sensor data acquisition and processing.

```APIDOC
BaseSensor:
  This is the base class for all realvirtual Sensor objects.
  See more at: https://realvirtual.io/apidoc/classrealvirtual_1_1_base_sensor.html#details
```

--------------------------------

### Other realvirtual Classes and Structs

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for various other classes and structs within the realvirtual namespace, including controllers, interfaces, and data structures.

```APIDOC
SetGroupPrefix:
  Description: Class for setting group prefixes.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_set_group_prefix.html

SettingsController:
  Description: Controller for managing settings.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_settings_controller.html

SettingsWindowCtrl:
  Description: Controller for the settings window.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_settings_window_ctrl.html

SEWSimInterface:
  Description: Interface for SEW simulation.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_s_e_w_sim_interface.html

SiemensSimitCoupler:
  Description: Represents the Siemens Simit Coupler.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_siemens_simit_coupler.html

SignalConnection:
  Description: Manages signal connections.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_connection.html

SignalData:
  Description: Represents signal data.
  Link: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_signal_data

SignalEvent:
  Description: Unity event for signal-based communication.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_event.html

SignalExport:
  Description: Handles signal export.
  Link: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_signal_export

SignalExportList:
  Description: Manages a list of signal exports.
  Link: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_signal_export_list

SignalHierarchyContextMenu:
  Description: Context menu for signal hierarchy.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_hierarchy_context_menu.html

SignalImporterExporter:
  Description: Imports and exports signals.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_importer_exporter.html

SignalInspectorWindow:
  Description: Window for inspecting signals.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_inspector_window.html

SignalReceiver:
  Description: Receives signals.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_receiver.html

SignalSender:
  Description: Sends signals.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_sender.html

SignalState:
  Description: Represents the state of a signal.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_signal_state.html

SimulationPath:
  Description: Represents a simulation path.
  Link: https://realvirtual.io/apidoc/classrealvirtual_1_1_simulation_path.html
```

--------------------------------

### BaseTransportSurface Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BaseTransportSurface class, serving as the foundation for all material transport surfaces in industrial automation simulations. It outlines the core attributes for defining transport surfaces.

```APIDOC
BaseTransportSurface:
  BaseTransportSurface serves as the foundation for all material transport surfaces in industrial automation simulations.
  See more at: https://realvirtual.io/apidoc/classrealvirtual_1_1_base_transport_surface.html#details
```

--------------------------------

### realvirtual::RobotJointSolution Class

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Represents a solution for robot joint configurations, storing a list of joint values.

```APIDOC
realvirtual::RobotJointSolution:
  joints: List< float >
```

--------------------------------

### MQTT Communication Interface

Source: https://realvirtual.io/apidoc/namespacerealvirtual

An interface for MQTT communication, facilitating lightweight publish-subscribe messaging for IoT and IIoT applications.

```APIDOC
class realvirtual.MQTTInterface
  // MQTT interface for IoT and IIoT communication using the lightweight publish-subscribe messaging protocol.
  // More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_m_q_t_t_interface.html#details
```

--------------------------------

### BehaviorInterfaceConnection Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BehaviorInterfaceConnection class, used for saving connection data between signals and properties. It stores the signal name and the property it is attached to.

```APIDOC
BehaviorInterfaceConnection:
  Class for saving the connection data - the signal and the name of the property where the signal is attached to.
  See more at: https://realvirtual.io/apidoc/namespacerealvirtual.html#classrealvirtual_1_1_behavior_interface_connection
```

--------------------------------

### ISourceCreated Interface Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Interface for Event Method by Source. On SourceCreated is called on all components implementing ISourceCreated.

```APIDOC
interface ISourceCreated
  description: Interface for Event Method by Source. On SourceCreated is called on all components implementing ISourceCreated.
  link: https://realvirtual.io/apidoc/interfacerealvirtual_1_1_i_source_created.html
```

--------------------------------

### Interact3D Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Adds buttons or Lights which can be connected to Signals tp a 3D scene.

```APIDOC
class Interact3D
  description: Adds buttons or Lights which can be connected to Signals tp a 3D scene.
  link: https://realvirtual.io/apidoc/classrealvirtual_1_1_interact3_d.html
```

--------------------------------

### SimplificationOptions Structure

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides options for controlling the mesh simplification process.

```APIDOC
SimplificationOptions:
  Description: Options for mesh simplification.
  Details: https://realvirtual.io/apidoc/structrealvirtual_1_1_simplification_options.html#details
```

--------------------------------

### SelectionRaycast - Runtime Object Selection

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Handles raycasting for selecting objects during runtime in the RealVirtual environment. This is crucial for user interaction with scene elements.

```APIDOC
class realvirtual::SelectionRaycast
  # Selection Raycast for selecting objects during runtime.
  # More details available at: https://realvirtual.io/apidoc/classrealvirtual_1_1_selection_raycast.html
```

--------------------------------

### realvirtual.io Test Classes

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for various test-related classes in the realvirtual namespace, likely used for testing simulation components.

```APIDOC
TestDriveRecordings:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_test_drive_recordings.html

TestModelController:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_test_model_controller.html

TestSensorCount:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_test_sensor_count.html

TestSensorSink:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_test_sensor_sink.html

TestSignalChanged:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_test_signal_changed.html

TestSmoothDrive:
  URL: https://realvirtual.io/apidoc/classrealvirtual_1_1_test_smooth_drive.html
```

--------------------------------

### BaseCAM Class Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Documentation for the BaseCAM class, serving as the fundamental base class for all CAM (Computer-Aided Manufacturing) objects within the realvirtual framework. It outlines the core structure for CAM-related functionalities.

```APIDOC
BaseCAM:
  This is the base class for all realvirtual CAM objects.
  See more at: https://realvirtual.io/apidoc/classrealvirtual_1_1_base_c_a_m.html#details
```

--------------------------------

### ConnectionState - Component Activation Logic

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Helper class that determines if components will be active based on their ActiveOnly settings. Manages the activation state of components in relation to connection statuses.

```APIDOC
ConnectionState:
  Description: Helper class that determines if components will be active based on their ActiveOnly settings.
  Details: https://realvirtual.io/apidoc/classrealvirtual_1_1_connection_state.html#details
```

--------------------------------

### InterfaceSHMBaseClass Documentation

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Base class for all types of shared memory interfaces (even with different structure as simit like the plcsimadvanced interface.

```APIDOC
class InterfaceSHMBaseClass
  description: Base class for all types of shared memory interfaces (even with different structure as simit like the plcsimadvanced interface.
  link: https://realvirtual.io/apidoc/classrealvirtual_1_1_interface_s_h_m_base_class.html
```

--------------------------------

### realvirtual Namespace Functions

Source: https://realvirtual.io/apidoc/namespacerealvirtual

Provides access to various functions within the realvirtual namespace for interacting with URSIM via RTDE. This includes functions for initialization, data transfer, and control.

```APIDOC
realvirtual Namespace Reference
Universal robots interface for communication with URSIM via RTDE. [More...](https://realvirtual.io/apidoc/namespacerealvirtual.html#details)

[Classes](https://realvirtual.io/apidoc/namespacerealvirtual.html#nested-classes) | [Enumerations](https://realvirtual.io/apidoc/namespacerealvirtual.html#enum-members) | [Functions](https://realvirtual.io/apidoc/namespacerealvirtual.html#func-members)
```
Tokens:
Raw