realvirtual.ManualPhysicsBlueprint Class Reference

Blueprint interface for manual physics control synchronized with FixedUpdate. More...

Inheritance diagram for realvirtual.ManualPhysicsBlueprint:

Public Member Functions
override void	PreFixedUpdate ()
	Override PreFixedUpdate to signal whether physics will step this frame.
override void	PostFixedUpdate ()
	Override PostFixedUpdate to step physics immediately after all FixedUpdate methods have run.
Public Member Functions inherited from realvirtual.FastInterfaceBase
override void	OpenInterface ()
	Opens the interface and starts communication thread.
override void	CloseInterface ()
	Closes the interface and stops communication thread.
void	SetManualPhysicsMode (bool enabled)
	Enables or disables manual physics control mode.
void	StepPhysics (float timestep=0f)
	Steps physics simulation forward by a specified time duration.
override void	PostAllScenesLoaded ()
	Override PostAllScenesLoaded to prevent base class from opening interface too early.
void	OnInterfaceEnable ()
	Called by realvirtualController after all scenes are loaded to enable the interface.
Public Member Functions inherited from realvirtual.InterfaceBaseClass
void	UpdateInterfaceSignals (ref int inputs, ref int outputs)
	Creates a new List of InterfaceSignals based on the Components under this Interface GameObject.
Signal	CreateSignalObject (string name, SIGNALTYPE type, SIGNALDIRECTION direction)
	Create a signal object as sub gameobject.
Signal	AddSignal (InterfaceSignal interfacesignal)
void	RemoveSignal (InterfaceSignal interfacesignal)
virtual GameObject	GetSignal (string name)
	Gets a signal with a name.
void	SetAllSignalStatus (bool connected)
void	DestroyAllSignals ()
void	DeleteSignals ()
Public Member Functions inherited from realvirtual.realvirtualBehavior
virtual void	OnOwnershipChanged (bool isOwner)
	Called when network ownership changes.
void	SetNetworkOwner (bool isOwner)
	Sets IsNetworkOwner and triggers OnOwnershipChanged callback.
void	PreStartSim ()
	Is called by the realvirtualController before the component is started.
void	StartSim ()
	Is called by the realvirtualController to start or stop the component.
void	StopSim ()
Vector3	DirectionToVector (DIRECTION direction)
	Transfers the direction enumeration to a vector.
DIRECTION	VectorToDirection (bool torotatoin, Vector3 vector)
	Transfers a vector to the direction enumeration.
float	GetLocalScale (Transform thetransform, DIRECTION direction)
List< BehaviorInterfaceConnection >	UpdateConnectionInfo ()
List< Signal >	GetConnectedSignals ()
void	SetVisibility (bool visibility)
	Sets the visibility of this object including all subobjects.
List< BehaviorInterfaceConnection >	GetConnections ()
List< Signal >	GetSignals ()
GameObject	GetChildByName (string name)
	Gets a child by name.
List< GameObject >	GetChildsByName (string name)
	Gets all child by name.
GameObject	GetChildByNameAlsoHidden (string name)
List< GameObject >	GetAllMeshesWithGroup (string group)
List< GameObject >	GetAllWithGroup (string group)
List< GameObject >	GetAllWithGroups (List< string > groups)
List< GameObject >	GetAllMeshesWithGroups (List< string > groups)
List< string >	GetMyGroups ()
List< GameObject >	GetMeshesWithSameGroups ()
List< GameObject >	GetAllWithSameGroups ()
MeshRenderer	GetMeshRenderer ()
	Gets the mesh renderers in the childrens.
void	SetCollider (bool enabled, bool includeTriggers=true)
	sets the collider in all child objects
void	ErrorMessage (string message)
	Displays an error message.
void	ChangeConnectionMode (bool isconnected)
void	Log (string message)
	Logs a message.
void	Log (string message, object obj)
	Logs a message with a relation to an object.
void	Warning (string message, object obj)
	Logs a warning with a relation to an object.
void	Error (string message, object obj)
	Logs an error with a relation to an object.
void	Error (string message)
	Logs an error.
GameObject	DebugPosition (string debugname, Vector3 position, Quaternion quaternation, float scale)
	Displays a gizmo for debugging positions.
void	SetFreezePosition (bool enabled)
	Freezes all child components to the current poosition.
void	SetRbConstraints (RigidbodyConstraints constraints)
virtual void	AwakeAlsoDeactivated ()

Public Attributes
string	ManualPhysicsStatus
	Current manual physics control status.
float	SpeedPercentage
	Physics simulation speed as percentage (100=real-time, 50=half speed via frame skipping, 25=quarter speed, 0=paused). Simulates external system throttling by skipping physics steps.
bool	EnableManualControl
	Enable manual physics control on start.
Public Attributes inherited from realvirtual.FastInterfaceBase
string	State
	Current connection status with visual indicator.
InterfaceState	state
	Internal connection state enum.
new string	ErrorMessage
	Last error message if connection failed.
int	ReconnectAttemptCount
	Number of reconnection attempts made.
bool	IsReconnecting
	Whether interface is currently attempting to reconnect.
int	InputSignals
	Total number of input signals found.
int	OutputSignals
	Total number of output signals found.
int	CommCycleMs
	Actual communication cycle time in milliseconds.
int	CycleCount
	Total number of communication cycles completed.
int	UpdateCycleMs
	Communication thread update interval in milliseconds.
bool	OnlyTransmitChangedInputs
	Only send input signals that have changed since last transmission (performance optimization)
bool	AutoReconnect
	Automatically attempt to reconnect on connection loss.
float	ReconnectIntervalSeconds
	Time to wait between reconnection attempts.
int	MaxReconnectAttempts
	Maximum reconnection attempts (-1 = unlimited)
bool	DebugMode
Public Attributes inherited from realvirtual.InterfaceBaseClass
bool	IsConnected
List< InterfaceSignal >	InterfaceSignals
Hashtable	SignalNamesOutputs
Hashtable	SignalNamesInputs
Public Attributes inherited from realvirtual.realvirtualBehavior
string	Name
	The name of the component if it should be different from the GameObject name.
ActiveOnly	Active
GameObject	FromTemplate
realvirtualController	realvirtualController
bool	HideNonG44Components
bool	SceneIsAdditive
bool	ForceStop
bool	IsNetworkOwner
	True when this component owns its simulation (local authority). Set to false by MultiplayerWEB on remote clients.

Protected Member Functions
override void	PrepareForBackgroundThread ()
	Override PrepareForBackgroundThread to initialize manual physics control BEFORE communication starts.
override void	CleanupAfterBackgroundThread ()
	Override CleanupAfterBackgroundThread to restore auto physics.
virtual void	OnApplicationQuit ()
	Cleanup when application quits or play mode stops.
override async System.Threading.Tasks.Task	EstablishConnection (System.Threading.CancellationToken cancellationToken)
	Override in derived classes to establish connection to external system.
override async System.Threading.Tasks.Task	CommunicationLoop (System.Threading.CancellationToken cancellationToken)
	Override in derived classes for communication loop with external system.
override void	CloseConnection ()
	Override in derived classes to close connection to external system.
Protected Member Functions inherited from realvirtual.FastInterfaceBase
virtual async Task	EstablishConnection (CancellationToken cancellationToken)
	Establishes connection to the external system.
virtual async Task	CommunicationLoop (CancellationToken cancellationToken)
	Main communication loop executed each cycle after connection is established.
virtual void	OnCommunicationError (Exception exception)
	Handles communication errors and manages reconnection logic.
virtual void	OnCommunicationStarted ()
	Called when communication thread starts successfully.
virtual void	OnCommunicationStopped ()
	Called when communication thread stops.
void	Start ()
	Unity Start - block base class behavior.
new void	OnEnable ()
	Unity OnEnable - opens interface when component is enabled.
new void	OnDisable ()
virtual void	OnApplicationPause (bool pauseStatus)
	Handles application pause events.
void	FixedUpdate ()
	Unity FixedUpdate for main thread operations (signal sync moved to PrePost FixedUpdate)
Dictionary< string, object >	GetInputsForPLC ()
	Gets all input signal values to send to PLC from background threads.
Dictionary< string, object >	GetChangedInputsForPLC ()
	Gets only changed input signal values to send to PLC from background threads.
void	ResetInputChangeDetection ()
	Resets change detection forcing all inputs to be considered changed on next call.
void	SetOutputsFromPLC (Dictionary< string, object > outputs)
	Sets output signal values from PLC data in background threads.
void	SetOutputFromPLC (string signalName, object value)
	Sets single output signal value from PLC data in background threads.
void	RebuildCachedSignalArrays ()
	Rebuilds the cached signal arrays used by SyncOutputsToUnity/SyncInputsFromUnity.
Dictionary< string, object >	ReadInputsThreadSafe ()
	[DEPRECATED] Use GetInputsForPLC() instead for clearer data flow direction
Dictionary< string, object >	ReadChangedInputsThreadSafe ()
	[DEPRECATED] Use GetChangedInputsForPLC() instead for clearer data flow direction
void	WriteOutputsThreadSafe (Dictionary< string, object > outputs)
	[DEPRECATED] Use SetOutputsFromPLC() instead for clearer data flow direction
void	WriteOutputThreadSafe (string signalName, object value)
	[DEPRECATED] Use SetOutputFromPLC() instead for clearer data flow direction
virtual void	CopyPropertiesToThreadSafe ()
	Copies MonoBehaviour properties to thread-safe variables before background thread starts.
virtual void	UpdateSignalCounts ()
	Updates input and output signal counts.
Protected Member Functions inherited from realvirtual.InterfaceBaseClass
void	OnConnected ()
void	OnDisconnected ()
void	OnEnable ()
void	OnDisable ()
Protected Member Functions inherited from realvirtual.realvirtualBehavior
bool	hidename ()
bool	hideactiveonly ()
virtual void	OnStopSim ()
virtual void	OnPreStartSim ()
virtual void	OnStartSim ()
MU	GetTopOfMu (GameObject obj)
	Gets the top of an MU component (the first MU script going up in the hierarchy)
void	InitGame4Automation ()
	Initialiates the components and gets the reference to the realvirtualController in the scene.
virtual void	AfterAwake ()
void	Awake ()

Properties
static bool	PhysicsWillStepThisFrame [get]
	Returns true if physics will be stepped this FixedUpdate frame.
Properties inherited from realvirtual.FastInterfaceBase
new bool	IsConnected [get]
override bool	ShowIsConnectedField [get]
	Used by [ShowIf] to hide IsConnected field for FastInterface classes - always returns false.
bool	IsInterfaceReady [get]
	Returns true if the interface has been initialized via OnInterfaceEnable.
Properties inherited from realvirtual.InterfaceBaseClass
virtual string	InterfaceDisplayName [get]
	Display name for interface in UI lists (removes "Interface" suffix by default, can be overridden for custom names)
virtual bool	ShowIsConnectedField [get]
Properties inherited from realvirtual.IOnInterfaceEnable

Additional Inherited Members
Public Types inherited from realvirtual.realvirtualBehavior
enum	ActiveOnly {   Always , Connected , Disconnected , Never ,   DontChange }
Static Public Member Functions inherited from realvirtual.FastInterfaceBase
static bool	IsManualPhysicsMode ()
	Gets whether manual physics mode is currently enabled globally.
Static Public Member Functions inherited from realvirtual.realvirtualBehavior
static bool	DirectionIsLinear (DIRECTION direction)
	Gets back if the direction is linear or a rotation.
Protected Attributes inherited from realvirtual.FastInterfaceBase
string	threadSafeErrorMessage
int	privateCycleCount
int	privateCommCycleMs
bool	threadSafeDebugMode
int	threadSafeUpdateCycleMs

Detailed Description

Blueprint interface for manual physics control synchronized with FixedUpdate.

Simulates external systems (e.g., FMU co-simulation, hardware interfaces) by controlling physics simulation timing. Physics.Simulate() is called in PostFixedUpdate immediately after all FixedUpdate scripts have run. Useful for testing how realvirtual behaves when physics stepping needs to be externally controlled. Derived classes implement specific communication protocols while inheriting the physics stepping control.

Member Function Documentation

CleanupAfterBackgroundThread()

override void realvirtual.ManualPhysicsBlueprint.CleanupAfterBackgroundThread ( )

protectedvirtual

Override CleanupAfterBackgroundThread to restore auto physics.

Reimplemented from realvirtual.FastInterfaceBase.

CloseConnection()

override void realvirtual.ManualPhysicsBlueprint.CloseConnection ( )

protectedvirtual

Override in derived classes to close connection to external system.

Reimplemented from realvirtual.FastInterfaceBase.

CommunicationLoop()

override async System.Threading.Tasks.Task realvirtual.ManualPhysicsBlueprint.CommunicationLoop ( System::Threading::CancellationToken  cancellationToken )

protected

Override in derived classes for communication loop with external system.

EstablishConnection()

override async System.Threading.Tasks.Task realvirtual.ManualPhysicsBlueprint.EstablishConnection ( System::Threading::CancellationToken  cancellationToken )

protected

Override in derived classes to establish connection to external system.

OnApplicationQuit()

virtual void realvirtual.ManualPhysicsBlueprint.OnApplicationQuit ( )

protectedvirtual

Cleanup when application quits or play mode stops.

PostFixedUpdate()

override void realvirtual.ManualPhysicsBlueprint.PostFixedUpdate ( )

virtual

Override PostFixedUpdate to step physics immediately after all FixedUpdate methods have run.

Reimplemented from realvirtual.FastInterfaceBase.

PreFixedUpdate()

override void realvirtual.ManualPhysicsBlueprint.PreFixedUpdate ( )

virtual

Override PreFixedUpdate to signal whether physics will step this frame.

Reimplemented from realvirtual.FastInterfaceBase.

PrepareForBackgroundThread()

override void realvirtual.ManualPhysicsBlueprint.PrepareForBackgroundThread ( )

protectedvirtual

Override PrepareForBackgroundThread to initialize manual physics control BEFORE communication starts.

Reimplemented from realvirtual.FastInterfaceBase.

Member Data Documentation

EnableManualControl

bool realvirtual.ManualPhysicsBlueprint.EnableManualControl

Enable manual physics control on start.

ManualPhysicsStatus

string realvirtual.ManualPhysicsBlueprint.ManualPhysicsStatus

Current manual physics control status.

SpeedPercentage

float realvirtual.ManualPhysicsBlueprint.SpeedPercentage

Physics simulation speed as percentage (100=real-time, 50=half speed via frame skipping, 25=quarter speed, 0=paused). Simulates external system throttling by skipping physics steps.

Property Documentation

PhysicsWillStepThisFrame

bool realvirtual.ManualPhysicsBlueprint.PhysicsWillStepThisFrame

staticget

Returns true if physics will be stepped this FixedUpdate frame.

Components can check this in their FixedUpdate to coordinate with manual physics.