realvirtual.InterfaceBaseClass Class Reference

Base class for all realvirtual communication interfaces providing common functionality for PLC and system connections. More...

Inheritance diagram for realvirtual.InterfaceBaseClass:

Public Member Functions
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.
virtual void	OpenInterface ()
virtual void	CloseInterface ()
void	SetAllSignalStatus (bool connected)
void	DestroyAllSignals ()
void	DeleteSignals ()
virtual void	PostAllScenesLoaded ()
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
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
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
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]

Additional Inherited Members
Public Types inherited from realvirtual.realvirtualBehavior
enum	ActiveOnly {   Always , Connected , Disconnected , Never ,   DontChange }
Static Public Member Functions inherited from realvirtual.realvirtualBehavior
static bool	DirectionIsLinear (DIRECTION direction)
	Gets back if the direction is linear or a rotation.

Detailed Description

Base class for all realvirtual communication interfaces providing common functionality for PLC and system connections.

Manages signal collection, initialization, and lifecycle for derived interface implementations. Automatically discovers and manages all child signal objects (PLCInput/PLCOutput) for data exchange. This abstract base class provides the foundation for creating custom interfaces to connect with external systems. Derive from this class to implement new communication protocols or integrate with proprietary automation systems.

Member Function Documentation

CloseInterface()

virtual void realvirtual.InterfaceBaseClass.CloseInterface ( )

virtual

Reimplemented in realvirtual.SEWSimInterface, realvirtual.TwinCatAdsInterface, realvirtual.BlueprintFastInterface, and realvirtual.FastInterfaceBase.

CreateSignalObject()

Signal realvirtual.InterfaceBaseClass.CreateSignalObject	(	string	name,
		SIGNALTYPE	type,
		SIGNALDIRECTION	direction
	)

Create a signal object as sub gameobject.

GetSignal()

virtual GameObject realvirtual.InterfaceBaseClass.GetSignal ( string  name )

virtual

Gets a signal with a name.

Reimplemented in realvirtual.S7Interface.

OpenInterface()

virtual void realvirtual.InterfaceBaseClass.OpenInterface ( )

virtual

Reimplemented in realvirtual.FestoInterface, realvirtual.SEWSimInterface, realvirtual.TwinCatAdsInterface, realvirtual.BlueprintFastInterface, and realvirtual.FastInterfaceBase.

PostAllScenesLoaded()

virtual void realvirtual.InterfaceBaseClass.PostAllScenesLoaded ( )

virtual

Implements realvirtual.IPostAllScenesLoaded.

Reimplemented in realvirtual.FastInterfaceBase.

UpdateInterfaceSignals()

void realvirtual.InterfaceBaseClass.UpdateInterfaceSignals	(	ref int	inputs,
		ref int	outputs
	)

Creates a new List of InterfaceSignals based on the Components under this Interface GameObject.

Property Documentation

InterfaceDisplayName

virtual string realvirtual.InterfaceBaseClass.InterfaceDisplayName

get

Display name for interface in UI lists (removes "Interface" suffix by default, can be overridden for custom names)