Programming Reference for VirtualLab Fusion  2025.1
Loading...
Searching...
No Matches
IProvidesPositioningReferences Interface Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Interface to be implemented by all classes that contain coordinate systems that can serve as positioning references More...

Inheritance diagram for IProvidesPositioningReferences:
OpticalMedium HomogeneousMedium

Public Member Functions

bool ContainsReferenceCoordinateSystemWithKey (string key)
 Method that gives a flag, indicating whether or not a coordinate system is contained that can be accessed via a certain key.
 
CartesianCoordinateSystem GetReferenceCoordinateSystemWithKey (string key)
 Method that gives the coordinate system the given key is assigned to.
 

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Interface to be implemented by all classes that contain coordinate systems that can serve as positioning references

Member Function Documentation

◆ ContainsReferenceCoordinateSystemWithKey()

bool ContainsReferenceCoordinateSystemWithKey ( string  key)

Method that gives a flag, indicating whether or not a coordinate system is contained that can be accessed via a certain key.

Parameters
keyKey to be checked
Returns
Flag, indicating whether or not a coordinate system is contained that can be accessed via the given key

◆ GetReferenceCoordinateSystemWithKey()

CartesianCoordinateSystem GetReferenceCoordinateSystemWithKey ( string  key)

Method that gives the coordinate system the given key is assigned to.

Parameters
keyKey that is assigned to one contained coordinate system
Returns
coordinate system the given key is assigned to