Unigine.Plugins.Syncker.Projections Class
Notice
Syncker plugin must be loaded.
This class represents an interface used to manage projections configuration of the Syncker.
Projections Class
Properties
bool Enabled#
The true if modification of projections on this host by the Syncker is enabled; otherwise, false.
bool ConfiguratorEnabled#
The true if modification of projections on this host by the Syncker is enabled; otherwise, false.
int NumDisplays#
The Current number of displays.
int NumProjectors#
The Current number of projectors.
bool DefaultProjectionsEnabled#
The
Members
void SaveProjections ( string file_name, bool binary = false ) #
Saves the current projections configuration to the specified file. You can use this method to migrate old binary files to the new XML format.Arguments
- string file_name - Name of the file to which the current projections configuration shall be saved.
- bool binary - Binary flag. Set true to save configuration in binary format; false - to save in XML format.
void LoadProjections ( string file_name, bool binary = false ) #
Loads projections configuration from the specified file. You can use this method to migrate old binary files to the new XML format.Arguments
- string file_name - Name of the file with projections configuration to be loaded.
- bool binary - Binary flag. Set true to load configuration from a binary file; false - to load configuration from an XML file.
int AddDisplay ( string name ) #
Adds a new display to the current configuration.Arguments
- string name - Name of the new display to be added.
Return value
Number of the new added display.void RemoveDisplay ( int num ) #
Removes the display with the specified number from the current configuration.Arguments
- int num - Number of the display to be removed in the range from 0 to the total number of displays.
void SetDisplayEnabled ( int num, bool enabled ) #
Sets a value indicating if the specified display is enabled.Arguments
- int num - Number of the display in the range from 0 to the total number of displays.
- bool enabled - true to enable the specified display; false - to disable it.
bool IsDisplayEnabled ( int num ) #
Returns a value indicating if the specified display is enabled.Arguments
- int num - Number of the display in the range from 0 to the total number of displays.
Return value
true if the specified display is enabled; otherwise, false.void SetDisplayName ( int num, string name ) #
Sets a new name for the display with the specified number.Arguments
- int num - Number of the display in the range from 0 to the total number of displays.
- string name - New name to be set for the specified display.
string GetDisplayName ( int num ) #
Returns the name of the display with the specified number.Arguments
- int num - Number of the display in the range from 0 to the total number of displays.
Return value
Name of the specified display.void SetDisplayTransform ( int num, mat4 transform ) #
Sets a new transformation for the display with the specified number.Arguments
- int num - Number of the display in the range from 0 to the total number of displays.
- mat4 transform - New transformation to be set for the specified display.
mat4 GetDisplayTransform ( int num ) #
Returns the current transformation of the display with the specified number.Arguments
- int num - Number of the display in the range from 0 to the total number of displays.
Return value
Current transformation of the specified display.int AddProjector ( string name ) #
Adds a new projector to the current configuration.Arguments
- string name - Name of the new projector to be added.
Return value
Number of the new added projector.void RemoveProjector ( int num ) #
Removes the projector with the specified number from the current configuration.Arguments
- int num - Number of the projector to be removed in the range from 0 to the total number of projectors.
void SetProjectorEnabled ( int num, bool enabled ) #
Sets a value indicating if the specified projector is enabled.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- bool enabled - true to enable the specified projector; false - to disable it.
bool IsProjectorEnabled ( int num ) #
Returns a value indicating if the specified projector is enabled.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
true if the specified projector is enabled; otherwise, false.void SetProjectorName ( int num, string name ) #
Sets a new name for the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- string name - New name to be set for the specified projector.
string GetProjectorName ( int num ) #
Returns the name of the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
Name of the specified projector.void SetProjectorTransform ( int num, mat4 transform ) #
Sets a new transformation for the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- mat4 transform - New transformation to be set for the specified projector. The transformation includes position (relative to the viewer), rotation, and size (width and height).
mat4 GetProjectorTransform ( int num ) #
Returns the current transformation of the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
Current transformation of the specified projector.void SetProjectorAspectRatio ( int num, float aspect ) #
Sets a new aspect ratio (width to height) for the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- float aspect - New aspect ratio to be set for the specified projector.
float GetProjectorAspectRatio ( int num ) #
Returns the current aspect ratio (width to height) of the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
Current aspect ratio of the specified projector.void SetProjectorVFOV ( int num, float vfov ) #
Sets a new vertical FOV (field of view) of the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- float vfov - New vertical field of view to be set for the specified projector, in degrees.
float GetProjectorVFOV ( int num ) #
Returns the current vertical FOV (field of view) of the projector with the specified number.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
Current vertical field of view of the specified projector, in degrees.void SetProjectorHorizontalOffset ( int num, float hoffset ) #
Sets a new horizontal offset of the viewport of the projector with the specified number. The offset measures the position of the image relative to the centerline of the lens.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- float hoffset - New horizontal offset to be set for the viewport of the specified projector, in meters.
float GetProjectorHorizontalOffset ( int num ) #
Returns the current horizontal offset of the viewport of the projector with the specified number. The offset measures the position of the image relative to the centerline of the lens.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
Current horizontal offset of the viewport of the specified projector, in meters.void SetProjectorVerticalOffset ( int num, float voffset ) #
Sets a new vertical offset of the viewport of the projector with the specified number. The offset measures the position of the image relative to the centerline of the lens.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
- float voffset - New vertical offset to be set for the viewport of the specified projector, in meters.
float GetProjectorVerticalOffset ( int num ) #
Returns the current vertical offset of the viewport of the projector with the specified number. The offset measures the position of the image relative to the centerline of the lens.Arguments
- int num - Number of the projector in the range from 0 to the total number of projectors.
Return value
Current vertical offset of the viewport of the specified projector, in meters.void SetDefaultProjectionsEnabled ( bool enabled ) #
Arguments
- bool enabled
bool IsDefaultProjectionsEnabled ( ) #
Last update:
2022-12-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)