diff --git a/2025R1_Test/speos/.gitignore b/2025R1_Test/speos/.gitignore new file mode 100644 index 0000000000..4378419e7f --- /dev/null +++ b/2025R1_Test/speos/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/2025R1_Test/speos/.vale.ini b/2025R1_Test/speos/.vale.ini new file mode 100644 index 0000000000..5f729aa176 --- /dev/null +++ b/2025R1_Test/speos/.vale.ini @@ -0,0 +1,10 @@ +StylesPath = styles + +Vocab = ansys + +MinAlertLevel = suggestion + +Packages = Google + +[*.md] +BasedOnStyles = Vale, Google diff --git a/2025R1_Test/speos/api/.gitignore b/2025R1_Test/speos/api/.gitignore new file mode 100644 index 0000000000..e8079a3bef --- /dev/null +++ b/2025R1_Test/speos/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/2025R1_Test/speos/api/index.md b/2025R1_Test/speos/api/index.md new file mode 100644 index 0000000000..78dc9c0057 --- /dev/null +++ b/2025R1_Test/speos/api/index.md @@ -0,0 +1,2 @@ +# PLACEHOLDER +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/2025R1_Test/speos/articles/TOC.yml b/2025R1_Test/speos/articles/TOC.yml new file mode 100644 index 0000000000..4660a0245c --- /dev/null +++ b/2025R1_Test/speos/articles/TOC.yml @@ -0,0 +1,149 @@ +- name: Introduction + href: client-speos-api-home.md +- name: Getting started + items: + - name: Creating a script + href: speos_getting_started\creating_script.md + - name: Forbidden values management + href: speos_getting_started\forbidden_values_management.md +- name: Cross-functional methods + href: crossfunctional_methods\crossfunctional_methods.md + items: + - name: Common methods + href: crossfunctional_methods\common_methods.md + - name: Geometry selection methods + href: crossfunctional_methods\geometry_selection_methods.md + - name: List (enum) parameters + href: crossfunctional_methods\list_enum_parameters.md + - name: ConvertToScriptVersion method + href: crossfunctional_methods\converttoscriptversion_method.md +- name: Speos Sim + href: sim\client-speos-sim.md + items: + - name: ResultLXP - GetMeasureValues method - List of possible values + href: sim\resultlxp_getmeasurevalue_list_enum.md + - name: Speos Sim script examples + href: sim\sim-example\sim_script_examples.md + items: + - name: Material - Creating and applying UV mapping + href: sim\sim-example\method_uvmap_applying_uv_mapping.md + - name: Material - Creating and applying materials + href: sim\sim-example\method_material_creating_applying_materials.md + - name: Component3Dtexture - Creating a 3D texture on a geometry + href: sim\sim-example\method_component3dtexture_creating_3d_texture_on_geometry.md + - name: ComponentExport - Creating a lightBox export + href: sim\sim-example\method_componentexport_creating_lightbox_export.md + - name: ComponentImport - Creating a lightBox import + href: sim\sim-example\method_componentimport_creating_lightbox_import.md + - name: LocalMeshing - Creating a local meshing + href: sim\sim-example\method_localmeshing_creating_local_meshing.md + - name: SourceAmbientCIEGeneral - Creating an ambient source CIE standard general sky + href: sim\sim-example\method_sourceambientciegeneral_creating_cie_general_sky.md + - name: SourceAmbientCIEOvercast - Creating an ambient source CIE standard overcast sky + href: sim\sim-example\method_sourceambientcieovercast_creating_cie_overcast_sky.md + - name: SourceAmbientEnvironment - Creating an environment ambient source + href: sim\sim-example\method_sourceambientenvironment_creating_environment.md + - name: SourceAmbientNaturalLight - Creating a natural light ambient source + href: sim\sim-example\method_sourceambientnaturallight_creating_natural_light.md + - name: SourceAmbientUniform - Creating an ambient source uniform + href: sim\sim-example\method_sourceambientuniform_creating_ambient_source_uniform.md + - name: SourceAmbienUS1976 - Creating an ambient source US standard atmosphere 1976 + href: sim\sim-example\method_sourceambientus1976_creating_ambient_source_us_1976.md + - name: SourceDisplay - Creating a display source + href: sim\sim-example\method_sourcedisplay_creating_display_source.md + - name: SourceInteractive - Creating an interactive source + href: sim\sim-example\method_sourceinteractive_creating_interactive_source.md + - name: SourceLuminaire - Creating a luminaire source + href: sim\sim-example\method_sourceluminaire_creating_luminaire_source.md + - name: SourceRayFile - Creating a ray file source + href: sim\sim-example\method_sourcerayfile_creating_ray_file_source.md + - name: SourceRayFile - Optimizing a ray file source + href: sim\sim-example\method_sourcerayfile_optimizing_ray_file_source.md + - name: SourceSurface - Creating a surface source + href: sim\sim-example\method_sourcesurface_creating_surface_source.md + - name: SourceThermic - Creating a thermic source + href: sim\sim-example\method_sourcethermic_creating_thermic_source.md + - name: Sensor3DED - Creating a 3D energy density sensor + href: sim\sim-example\method_sensor3ded_creating_3d_energy_density_sensor.md + - name: Sensor3Dirradiance - Creating a 3D irradiance sensor + href: sim\sim-example\method_sensor3dirradiance_creating_3d_irradiance_sensor.md + - name: SensorCamera - Creating a camera sensor + href: sim\sim-example\method_sensorcamera_creating_camera_sensor.md + - name: SensorEye - Creating an eye sensor + href: sim\sim-example\method_sensoreye_creating_eye_sensor.md + - name: SensorImmersive - Creating an immersive sensor + href: sim\sim-example\method_sensorimmersive_creating_immersive_sensor.md + - name: SensorIntensity - Creating an intensity sensor + href: sim\sim-example\method_sensorintensity_creating_intensity_sensor.md + - name: SensorIrradiance - Creating an irradiance sensor + href: sim\sim-example\method_sensorirradiance_creating_irradiance_sensor.md + - name: SensorLidar - Creating a LiDAR sensor + href: sim\sim-example\method_sensorlidar_creating_lidar_sensor.md + - name: SensorObserver - Creating an observer sensor + href: sim\sim-example\method_sensorobserver_creating_observer_sensor.md + - name: SensorRadiance - Creating a radiance sensor + href: sim\sim-example\method_sensorradiance_creating_radiance_sensor.md + - name: SensorRotatingLidar - Creating a rotating LiDAR sensor + href: sim\sim-example\method_sensorrotatinglidar_creating_rotating_lidar_sensor.md + - name: SimulationInteractive - Setting an interactive simulation + href: sim\sim-example\method_simulationinteractive_setting_interactive_simulation.md + - name: SimulationInteractive - Creating and using an interactive simulation + href: sim\sim-example\method_simulationinteractive_creating_using_interactive_simulation.md + - name: SimulationDirect - Creating a direct simulation + href: sim\sim-example\method_simulationdirect_creating_direct_simulation.md + - name: DirectSImulationSettings - Setting a direct simulation + href: sim\sim-example\method_directsimulationsettings_setting_direct_simulation.md + - name: SimulationInverse - Creating an inverse simulation + href: sim\sim-example\method_simulationinverse_creating_inverse_simulation.md + - name: InverseSimulationSettings - Setting an inverse simulation + href: sim\sim-example\method_inversesimulationsettings_setting_inverse_simulation.md + - name: SimulationRotatingLidar - Creating a rotating LiDAR simulation + href: sim\sim-example\method_simulationrotatinglidar_creating_rotating_lidar_simulation.md + - name: SimulationHoa - Creating a HUD optical analysis simulation + href: sim\sim-example\method_simulationhoa_creating_hud_optical_analysis_simulation.md + - name: LXPEnabledSensor - Activating the light expert on a sensor + href: sim\sim-example\method_lxpenabledsensor_activating_lxp_on_sensor.md + - name: FTGEnabledGeometry - Activating the fast transmission gathering on a geometry + href: sim\sim-example\method_ftgenabledgeometry_activating_ftg_on_geometry.md + - name: EyeboxConfiguration - Defining a HUD optical analysis with multi-eyebox configuration + href: sim\sim-example\method_eyeboxconfiguration_defining_hoa_multieyebox.md + - name: ResultLXP - Analyzing the interactive simulation light expert result + href: sim\sim-example\method_resultlxp_analyzing_interactive_simulation_lxp_result.md + - name: ResultLXP - Exporting rays as geometry out of a light expert result + href: sim\sim-example\method_resultlxp_exporting_rays_as_geometry_lxp_result.md + - name: ResultProjectedGrid - Exporting a projected grid as geometry + href: sim\sim-example\method_resultprojectedgrid_exporting_projected_grid_as_geometry.md + - name: Options - Retrieving values + href: sim\sim-example\method_options_retrieving_values.md + - name: Options - Updating values + href: sim\sim-example\method_options_updating_values.md + - name: Options - Reseting values + href: sim\sim-example\method_options_reseting_values.md +- name: Speos Des + href: des\client-speos-des.md + items: + - name: Speos Des script examples + href: des\des-example\des_script_examples.md + items: + - name: LightGuide - Exporting prism parameters as CSV file + href: des\des-example\method_lightguide_exporting_prism_parameters_csv.md + - name: LightGuide - Defining control points to create parameters variation along the guide + href: des\des-example\method_lightguide_defining_control_points_variation.md + - name: ProjectionLens - Getting - setting aspheric parameters + href: des\des-example\method_projectionlens_getting_setting_aspheric_parameters.md + - name: PERAngularSection - Managing the beam spread of a poly ellipsoidal reflector + href: des\des-example\method_perangularsection_managing_beam_spread_per.md + - name: PERAngularSection - Using the FittingControlPlane method + href: des\des-example\method_perangularsection_fittingcontrolplane.md + - name: HUDOD - Getting - Setting advanced parameters to improve HUD system + href: des\des-example\method_hudod_getting_setting_advanced_parameters.md +- name: Speos Asm + href: asm\client-speos-asm.md + items: + - name: Speos Asm script examples + href: asm\asm-example\asm_script_examples.md + items: + - name: CADUpdate - Importing a geometry + href: asm\asm-example\method_cadupdate_importing_geometry.md + - name: CADUpdate - Updating a geometry + href: asm\asm-example\method_cadupdate_updating_geometry.md \ No newline at end of file diff --git a/2025R1_Test/speos/articles/asm/asm-example/asm_script_examples.md b/2025R1_Test/speos/articles/asm/asm-example/asm_script_examples.md new file mode 100644 index 0000000000..304a6ff515 --- /dev/null +++ b/2025R1_Test/speos/articles/asm/asm-example/asm_script_examples.md @@ -0,0 +1,6 @@ +# SpeosAsm script examples + +The following section provides you with a list of script samples to help you create your own script. + + - CADUpdate – [Importing a geometry](method_cadupdate_importing_geometry.md) + - CADUpdate – [Updating a geometry](method_cadupdate_updating_geometry.md) diff --git a/2025R1_Test/speos/articles/asm/asm-example/method_cadupdate_importing_geometry.md b/2025R1_Test/speos/articles/asm/asm-example/method_cadupdate_importing_geometry.md new file mode 100644 index 0000000000..1f59dfa64a --- /dev/null +++ b/2025R1_Test/speos/articles/asm/asm-example/method_cadupdate_importing_geometry.md @@ -0,0 +1,16 @@ +# CADUpdate – Importing a geometry + +The following script sample shows you an example on how to import a geometry. + +```ironpython +from System.IO import Path + +currentFilePath = GetRootPart().Document.Path +currentPath = Path.GetDirectoryName(currentFilePath) + +speFile1 = currentPath + "\\" + "lguide.prt" +speFile2 = currentPath + "\\" + "led.prt" + +stest1 = SpeosAsm.CADUpdate.Import(speFile1) +test2 = SpeosAsm.CADUpdate.Import(speFile2) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/asm/asm-example/method_cadupdate_updating_geometry.md b/2025R1_Test/speos/articles/asm/asm-example/method_cadupdate_updating_geometry.md new file mode 100644 index 0000000000..5c31fc2afb --- /dev/null +++ b/2025R1_Test/speos/articles/asm/asm-example/method_cadupdate_updating_geometry.md @@ -0,0 +1,37 @@ +# CADUpdate – Updating a geometry + +The following script sample shows you an example on how to update a geometry. + +```ironpython +def checkImportedPart(importedPart): +print "File path: " + str(SpeosAsm.CADUpdate.GetLastImportedFilePath(importedPart)) +print "Last update: " + str(SpeosAsm.CADUpdate.GetLastImportedFileDateTime(importedPart)) + +def updateImportedPart(importedPart): +lastUpdate = SpeosAsm.CADUpdate.GetLastImportedFileDateTime(importedPart) +bUpdate = SpeosAsm.CADUpdate.Update(importedPart, True, True) +print "Update did work (unmodified parts skipped)? " + str(bUpdate) + +bUpdate = SpeosAsm.CADUpdate.Update(importedPart, True, False) +print "Update did work (unmodified parts not skipped)? " + str(bUpdate) + +# Update +previousUpdate = lastUpdate +lastUpdate = SpeosAsm.CADUpdate.GetLastImportedFileDateTime(importedPart) +if lastUpdate != previousUpdate: +print "Last update: " + str(SpeosAsm.CADUpdate.GetLastImportedFileDateTime(importedPart)) + +# Update all imported files that have been imported +currentPart = GetRootPart() +importedParts = SpeosAsm.CADUpdate.GetImportedPartsUnder() + +bUpdate = SpeosAsm.CADUpdate.UpdateAll(currentPart, True, True) +print "Update all parts did work (unmodified parts skipped)? " + str(bUpdate) + +bUpdate = SpeosAsm.CADUpdate.UpdateAll(currentPart, True, False) +print "Update all parts did work (unmodified parts not skipped)? " + str(bUpdate) + +for importedPart in importedParts: +checkImportedPart(importedPart) +updateImportedPart(importedPart) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/asm/client-speos-asm.md b/2025R1_Test/speos/articles/asm/client-speos-asm.md new file mode 100644 index 0000000000..2c1bf7dda9 --- /dev/null +++ b/2025R1_Test/speos/articles/asm/client-speos-asm.md @@ -0,0 +1,21 @@ +# SpeosAsm + +## CADUpdate + +### Static method + +Name | Description | Syntax +--- | --- | --- +Import | Import an external CAD file (CATProduct, CATPart, prt...) under the target Part's Component. Use `null` value for the `targetPart` parameter to import in the active Part. | `bool Import(string externalCadFilePath, object targetPart)` +Import | Import an external CAD file (CATProduct, CATPart, prt...) under the target Part's Component. Use `null` value for the `targetPart` parameter to import in the active Part. | `bool Import(string externalCadFilePath, SpaceClaim.Api.V251.Part targetPart)` +GetImportedPartsUnder | Get all Parts that are associated to a CAD-Import process, starting from the given Part. | `IEnumerable GetImportedPartsUnder(object targetPart)` +GetImportedPartsUnder | Get all Parts that are associated to a CAD-Import process, starting from the given Part. | `IEnumerable GetImportedPartsUnder(SpaceClaim.Api.V251.Part targetPart)` +GetImportedPartsUnder | Get all Parts that are associated to a CAD-Import process, starting from the given Component. | `IEnumerable GetImportedPartsUnder(SpaceClaim.Api.V251.Component component)` +GetLastImportedFilePath | Get the file path previously used to import the given Part. Returns 'null' if no CAD-Import information is found for this Part. | `string GetLastImportedFilePath(object targetPart)` +GetLastImportedFilePath | Get the file path previously used to import the given Part. Returns 'null' if no CAD-Import information is found for this Part. | `string GetLastImportedFilePath(SpaceClaim.Api.V251.Part targetPart)` +GetLastImportedFileDateTime | Get the last write DateTime of the imported file at the time when the part was imported or updated. Returns `DateTime.MinValue` if no CAD-Import information is found for this Part. | `System.DateTime GetLastImportedFileDateTime(object targetPart)` +GetLastImportedFileDateTime | Get the last write DateTime of the imported file at the time when the part was imported or updated. Returns `DateTime.MinValue` if no CAD-Import information is found for this Part. | `System.DateTime GetLastImportedFileDateTime(SpaceClaim.Api.V251.Part targetPart)` +Update | Update a Part resulting from a previous CAD-Import with the same file path. Returns 'true' if and only if the Part was updated. | `bool Update(object targetPart, bool skipPartsWithUnknownPath, bool skipUnmodifiedFiles)` +Update | Update a Part resulting from a previous CAD-Import with the same file path. Returns 'true' if and only if the Part was updated. | `bool Update(SpaceClaim.Api.V251.Part targetPart, bool skipPartsWithUnknownPath, bool skipUnmodifiedFiles)` +UpdateAll | Update all previously imported Parts from a given root Part. Returns 'true' if and only if at least one Part has been updated. | `bool UpdateAll(object targetPart, bool skipPartsWithUnknownPath, bool skipUnmodifiedFiles)` +UpdateAll | Update all previously imported Parts from a given root Part. Returns 'true' if and only if at least one Part has been updated. | `bool UpdateAll(SpaceClaim.Api.V251.Part targetPart, bool skipPartsWithUnknownPath, bool skipUnmodifiedFiles)` diff --git a/2025R1_Test/speos/articles/client-speos-api-home.md b/2025R1_Test/speos/articles/client-speos-api-home.md new file mode 100644 index 0000000000..f2025ef48d --- /dev/null +++ b/2025R1_Test/speos/articles/client-speos-api-home.md @@ -0,0 +1,24 @@ +# Introduction + +The **Speos client APIs** are intricately linked to the GUI, ensuring that every feature accessible in the GUI has a corresponding automation function. As the automation functions are directly derived from the GUI, they perfectly align with the actions you would have to perform in the software such as creating new Speos objects, editing existing ones, and modifying parameters. + +The **Speos client APIs** consists of three distinct interfaces: + +- **[SpeosSim](sim/client-speos-sim.md)**: Offering a comprehensive suite of Light Simulation features. +- **[SpeosDes](des/client-speos-des.md)**: Encompassing all Optical Part Design features. +- **[SpeosAsm](asm/client-speos-asm.md)**: Providing the Geometry Update feature. + +In addition to the **Speos client APIs** documentation, the Speos Core methods and some common cross-functional methods are provided in the following sections: + +- **[Cross-functional methods](crossfunctional_methods/common_methods.md)** +- **[Speos Core methods](https://developer.ansys.com/docs/speos)** + +This documentation provides a modular presentation of the **Speos client APIs** functions: + +- The first column provides you with the **method** and **property** name. The method/property hierarchy is simply expressed in the file structure. The name of a section refers to a "parent" method (for example a feature level). All dependent methods are listed below it. +- The second column provides you with the method/property **Description**. +- The third column provides the method's **Syntax**. The syntax corresponds to a template for the use of the methods with its return value and arguments. + - The return value is used as an intermediary step in the method calculation. These values are, therefore, both indicating which value is expected as a result of the function and what type of input is expected by the method. + - Arguments are always declared with parenthesis () and correspond to variables that must be provided to obtain the method's result. + +In Speos, arguments often correspond to axis system definitions. diff --git a/2025R1_Test/speos/articles/crossfunctional_methods/common_methods.md b/2025R1_Test/speos/articles/crossfunctional_methods/common_methods.md new file mode 100644 index 0000000000..6418fcabab --- /dev/null +++ b/2025R1_Test/speos/articles/crossfunctional_methods/common_methods.md @@ -0,0 +1,111 @@ +# Common methods + +Common methods are cross-functional standard functions. + +## Create + +**Create** creates a new feature. + +```ironpython +newMaterial = SpeosSim.Material.Create() +``` + +## Find + +**Find** looks for a custom object by its name and directly gets the corresponding object in the active component. + +```ironpython +existingMaterial = SpeosSim.Material.Find("Plastic") +``` + +## Print + +Setting and getting values can be easily done, mainly though the `set` and `print` functions. Most values of parameters are numeric, strings or booleans. + +**print** gets the value of a specific parameter: `print irradianceSensor.YResolution` +Setting values is done by assigning a value, string or boolean to a Speos object. + +```ironpython +#Example of irradiance sensor definition +irradianceSensor = SpeosSim.SensorIrradiance.Create() +print irradianceSensor.XStart +print irradianceSensor.XEnd +print irradianceSensor.XResolution +irradianceSensor.XIsMirrored = True +irradianceSensor.XEnd = 15 +irradianceSensor.XResolution = 500 +print irradianceSensor.YStart +print irradianceSensor.YEnd +print irradianceSensor.YResolution +irradianceSensor.YIsMirrored = True +irradianceSensor.YEnd = 15 +irradianceSensor.YResolution = 500 +print irradianceSensor.XMPTemplateFile +irradianceSensor.XMPTemplateFile = ".\\SPEOS input file\\xmpTemplate.xml" +``` + +## Clone + +**Clone** copies the object. + +```ironpython +copiedMaterial = existingMaterial.Clone() +``` + +## Delete + +**Delete** deletes the oject. + +```ironpython +copiedMaterial.Delete() +``` + +## Name + +**Name** gets or modifies the name of the feature. + +```ironpython +plasticMaterial.Name = "Plastic" +``` + +## Visible + +**Visible** gets or modifies the visibility of the feature. + +```ironpython +existingSource.Visible = False +``` + +## Subject + +**Subject** returns the underlying CustomObject. + +```ironpython +Selection.Create(existingMaterial.Subject) +``` + +## StatusInfo + +**StatusInfo** returns the warnings or error messages associated to the feature. If there are no errors, the returned string is empty. + +```ironpython +print inverseSimulation.StatusInfo +``` + +## PublishAllParameterstoWorkbench + +**PublishAllParameterstoWorkbench** exposes the attributes of Speos elements so that Ansys Workbench can access and drive them. + +```ironpython +existingSource.PublishAllParametersToWorkbench(True) +``` + +## Compute + +**Compute** is used to trigger the generation of any object. + +```ironpython +inverseSimulation.Compute() +``` + +**Note:** Computation is not automatic on features during the script process as Compute events are executed at the end of the "Script" Command. So if you want your features to be up to date, you need to call explicitly the Compute\(\) method on objects that are usually supposed to update automatically in the interactive session. diff --git a/2025R1_Test/speos/articles/crossfunctional_methods/converttoscriptversion_method.md b/2025R1_Test/speos/articles/crossfunctional_methods/converttoscriptversion_method.md new file mode 100644 index 0000000000..65b3c4e6ae --- /dev/null +++ b/2025R1_Test/speos/articles/crossfunctional_methods/converttoscriptversion_method.md @@ -0,0 +1,23 @@ +# ConvertToScriptVersion method + +## Description + +This function allows you to convert retrieved geometry objects, from a Speos object selection attribute \(i.e. Items, LinkedObjects\), from the latest Speos API version to the anterior script version that you want to edit. + +## Python Definition + +```ironpython +import SpaceClaim.Api.V20 as scriptNameSpace + +def ConvertToScriptVersion(obj): + doc = Window.ActiveWindow.Document + res = scriptNameSpace.Moniker[scriptNameSpace.IDocObject].FromString(obj.Moniker.ToString()).Resolve(doc) + return res +``` + +## Example + +```ironpython +docObjInScriptVersion = ConvertToScriptVersion( docObjInSpeosVersion ) +print docObjInScriptVersion # => V20 => OK +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/crossfunctional_methods/crossfunctional_methods.md b/2025R1_Test/speos/articles/crossfunctional_methods/crossfunctional_methods.md new file mode 100644 index 0000000000..5c2df21265 --- /dev/null +++ b/2025R1_Test/speos/articles/crossfunctional_methods/crossfunctional_methods.md @@ -0,0 +1,8 @@ +# Cross-Functional methods + +This section gathers standard methods that can be used across almost any Speos feature. + + - [Common methods](common_methods.md) + - [Geometry selection methods](geometry_selection_methods.md) + - [List (Enum) parameters](list_enum_parameters.md) + - [ConvertToScriptVersion](converttoscriptversion_method.md) \ No newline at end of file diff --git a/2025R1_Test/speos/articles/crossfunctional_methods/geometry_selection_methods.md b/2025R1_Test/speos/articles/crossfunctional_methods/geometry_selection_methods.md new file mode 100644 index 0000000000..aff4d7f468 --- /dev/null +++ b/2025R1_Test/speos/articles/crossfunctional_methods/geometry_selection_methods.md @@ -0,0 +1,46 @@ +# Geometry selection methods + +Geometry selections are required for almost any Speos object definition. They can be performed using the SpaceClaim selection. + + - Generic object selection can be performed using the SpaceClaim + + ```ironpython + Geometries can be set using the SpaceClaim Selection: + geometry1 = GetRootPart().Bodies[3] + geometry2 = GetRootPart().Bodies[8] + geometry3 = GetRootPart().Bodies[10] + newMaterial.VolumeGeometries.Set(Selection.Create([geometry1, geometry2, geometry3])) + ``` + + ```ironpython + Selection.Create(GetRootPart().Bodies[3]).SetActive() + Selection.Create(GetRootPart().Bodies[8]).AddToActive() + Selection.Create(GetRootPart().Bodies[10]).AddToActive() + newMaterial.VolumeGeometries.Set(Selection.GetActive()) + ``` + + - Origin or directions selection + + ```ironpython + displaySource = SpeosSim.SourceDisplay.Create() + displayOrigin = Selection.Create(GetRootPart().CoordinateSystems[0]) + displaySource.OriginPoint.Set(displayOrigin) + + displayXDirection = Selection.Create(GetRootPart().CoordinateSystems[0].Axes[0]) + displaySource.XDirection.Set(displayXDirection) + + displayYDirection = Selection.Create(GetRootPart().CoordinateSystems[0].Axes[1]) + displaySource.YDirection.Set(displayYDirection) + ``` + + - Oriented faces selection \(used in surface sources or FOPs to orientate the normal to the selected faces\) + + ```ironpython + orientedFace = SpeosSim.OrientedFace.Create() + emissiveFace = Selection.Create(GetRootPart().Bodies[7].Faces[0]) + orientedFace.Face.Set(emissiveFace) + orientedFace.ReverseDirection = True + + surfaceSource = SpeosSim.SourceSurface.Create() + surfaceSource.EmissiveFaces.Add(orientedFace) + ``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/crossfunctional_methods/list_enum_parameters.md b/2025R1_Test/speos/articles/crossfunctional_methods/list_enum_parameters.md new file mode 100644 index 0000000000..7651e71c7f --- /dev/null +++ b/2025R1_Test/speos/articles/crossfunctional_methods/list_enum_parameters.md @@ -0,0 +1,25 @@ +# List (Enum) parameters + +Parameters that are defined though a choice list (usually a **Type** list in the Speos interface) can be changed using their corresponding `enum`. For instance, there are three different types of volume properties (opaque, optic and library) and three types of surface properties (mirror, optical polished, library) in the Material definition: + +```ironpython +#Example of the use of enum to define optical properties +newMaterial = SpeosSim.Material.Create() +newMaterial.Name = "Plastic" +newMaterial.VOPType = SpeosSim.Material.EnumVOPType.Opaque +newMaterial.SOPType = SpeosSim.Material.EnumSOPType.Library +newMaterial.SOPLibrary = ".\\SPEOS input files\\Plastic.simplescattering" +``` + +For lists that are not predefined, for example the possible locations of a Natural Light Ambient Source, the complete list of `enums` can be obtained though a `Get` method and parsed to find the useful value. + +```ironpython +naturalLight = SpeosSim.SourceAmbientNaturalLight.Create() +locations = naturalLight.GetLocationPossibleValues() +locationLabel = "" +for locationLabel in locations: + print locationLabel + if locationLabel.Contains("Boston"): + break +naturalLight.Location = locationLabel +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/client-speos-des.md b/2025R1_Test/speos/articles/des/client-speos-des.md new file mode 100644 index 0000000000..ab227781ff --- /dev/null +++ b/2025R1_Test/speos/articles/des/client-speos-des.md @@ -0,0 +1,4328 @@ +# SpeosDes + +## Command + +### Static method + +Name | Description | Syntax +--- | --- | --- +GetErrorStatus | Get the error status of the given object | `string GetErrorStatus(object docObject)` +IsUpToDate | Ask if the given object was modified since its last successful computation | `bool IsUpToDate(object docObject)` +SetActiveSelection | Set the active selection from a collection of DocObjects | `void SetActiveSelection(ICollection selectedObjects)` +GetSpeosObjectsInActivePart | Get the Speos objects contained in the active Part | `IEnumerable GetSpeosObjectsInActivePart()` +Compute | Perform the computation of an array of objects | `void Compute(System.Object[] selectedObjects)` +Compute | Perform the computation of an array of DocObjects | `void Compute(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Compute | Perform the computation of an array of script objects | `void Compute(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +ComputeOnActiveSelection | Perform the computation of the active selection | `void ComputeOnActiveSelection()` + +## Aspherics + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.Aspherics Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Index | Number attribute | `int Index` +IndexText | Number attribute (as text) | `string IndexText` +Value | Number attribute | `double Value` +ValueText | Number attribute (as text) | `string ValueText` + +## CircularLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.CircularLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.CircularLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.CircularLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.CircularLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.CircularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleCircular Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.CircularLens.CircularLensGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.CircularLens.CircularLensTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### CircularLens.CircularLensGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### CircularLens.CircularLensTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## CircularSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.CircularSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.CircularSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.CircularSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.CircularSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.CircularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleCircular Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.CircularSurface.CircularSurfaceGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.CircularSurface.CircularSurfaceTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### CircularSurface.CircularSurfaceGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### CircularSurface.CircularSurfaceTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## ControlPlane + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.ControlPlane Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Position | Number attribute | `double Position` +PositionText | Number attribute (as text) | `string PositionText` +Defocus | Number attribute | `double Defocus` +DefocusText | Number attribute (as text) | `string DefocusText` +HorizontalSpread | Number attribute | `double HorizontalSpread` +HorizontalSpreadText | Number attribute (as text) | `string HorizontalSpreadText` +VerticalOrientation | Number attribute | `double VerticalOrientation` +VerticalOrientationText | Number attribute (as text) | `string VerticalOrientationText` +VerticalSpread | Number attribute | `double VerticalSpread` +VerticalSpreadText | Number attribute (as text) | `string VerticalSpreadText` +Tilt | Number attribute | `double Tilt` +TiltText | Number attribute (as text) | `string TiltText` + +## ControlPointConfiguration + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.ControlPointConfiguration Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Position | Number attribute | `double Position` +PositionText | Number attribute (as text) | `string PositionText` +Value | Number attribute | `double Value` +ValueText | Number attribute (as text) | `string ValueText` + +## EyeboxConfiguration + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.EyeboxConfiguration Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +EBConfigName | string attribute | `string EBConfigName` +Offset | Number attribute | `double Offset` +OffsetText | Number attribute (as text) | `string OffsetText` +Weight | Number attribute | `double Weight` +WeightText | Number attribute (as text) | `string WeightText` + +## FreeformLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.FreeformLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.FreeformLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.FreeformLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.FreeformLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.FreeformLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +ConstructionType | Enum attribute | `SpeosDes.FreeformLens.EnumConstructionType ConstructionType` +ConstructionTypeIndex | Enum attribute (as index) | `int ConstructionTypeIndex` +FocalPoint | Link attribute | `SpeosDes.FreeformLens.FreeformLensFocalPoint FocalPoint` +OpticalAxis | Link attribute | `SpeosDes.FreeformLens.FreeformLensOpticalAxis OpticalAxis` +ReverseDirection | boolean attribute | `bool ReverseDirection` +RefractiveIndex | Number attribute | `double RefractiveIndex` +RefractiveIndexText | Number attribute (as text) | `string RefractiveIndexText` +FrontFace | Link attribute | `SpeosDes.FreeformLens.FreeformLensFrontFace FrontFace` +Thickness | Number attribute | `double Thickness` +ThicknessText | Number attribute (as text) | `string ThicknessText` +TargetDefinitionType | Enum attribute | `SpeosDes.FreeformLens.EnumTargetDefinitionType TargetDefinitionType` +TargetDefinitionTypeIndex | Enum attribute (as index) | `int TargetDefinitionTypeIndex` +TargetOrigin | Link attribute | `SpeosDes.FreeformLens.FreeformLensTargetOrigin TargetOrigin` +TargetXAxis | Link attribute | `SpeosDes.FreeformLens.FreeformLensTargetXAxis TargetXAxis` +TargetYAxis | Link attribute | `SpeosDes.FreeformLens.FreeformLensTargetYAxis TargetYAxis` +IntensityOpticalAxis | Link attribute | `SpeosDes.FreeformLens.FreeformLensIntensityOpticalAxis IntensityOpticalAxis` +ReverseIntensityOpticalAxisDirection | boolean attribute | `bool ReverseIntensityOpticalAxisDirection` +IntensityOrientationAxis | Link attribute | `SpeosDes.FreeformLens.FreeformLensIntensityOrientationAxis IntensityOrientationAxis` +ReverseIntensityOrientationAxisDirection | boolean attribute | `bool ReverseIntensityOrientationAxisDirection` +TargetType | Enum attribute | `SpeosDes.FreeformLens.EnumTargetType TargetType` +TargetTypeIndex | Enum attribute (as index) | `int TargetTypeIndex` +XTargetMax | Number attribute | `double XTargetMax` +XTargetMaxText | Number attribute (as text) | `string XTargetMaxText` +YTargetMax | Number attribute | `double YTargetMax` +YTargetMaxText | Number attribute (as text) | `string YTargetMaxText` +XTargetGaussian | Number attribute | `double XTargetGaussian` +XTargetGaussianText | Number attribute (as text) | `string XTargetGaussianText` +YTargetGaussian | Number attribute | `double YTargetGaussian` +YTargetGaussianText | Number attribute (as text) | `string YTargetGaussianText` +ImageFilePath | File attribute | `string ImageFilePath` +ImageFilePathFullPath | File attribute (absolute full path) | `string ImageFilePathFullPath` +TargetTypeIntensity | Enum attribute | `SpeosDes.FreeformLens.EnumTargetTypeIntensity TargetTypeIntensity` +TargetTypeIntensityIndex | Enum attribute (as index) | `int TargetTypeIntensityIndex` +IntensityXHalfSpread | Number attribute | `double IntensityXHalfSpread` +IntensityXHalfSpreadText | Number attribute (as text) | `string IntensityXHalfSpreadText` +IntensityYHalfSpread | Number attribute | `double IntensityYHalfSpread` +IntensityYHalfSpreadText | Number attribute (as text) | `string IntensityYHalfSpreadText` +IntensityXFWHMGaussian | Number attribute | `double IntensityXFWHMGaussian` +IntensityXFWHMGaussianText | Number attribute (as text) | `string IntensityXFWHMGaussianText` +IntensityYFWHMGaussian | Number attribute | `double IntensityYFWHMGaussian` +IntensityYFWHMGaussianText | Number attribute (as text) | `string IntensityYFWHMGaussianText` +IntensityFilePath | File attribute | `string IntensityFilePath` +IntensityFilePathFullPath | File attribute (absolute full path) | `string IntensityFilePathFullPath` +ImageContrast | Number attribute | `int ImageContrast` +ImageContrastText | Number attribute (as text) | `string ImageContrastText` +ResolutionFactor | Number attribute | `int ResolutionFactor` +ResolutionFactorText | Number attribute (as text) | `string ResolutionFactorText` +Threshold | Number attribute | `int Threshold` +ThresholdText | Number attribute (as text) | `string ThresholdText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### FreeformLens.FreeformLensFocalPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensFrontFace + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensTargetOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensTargetXAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensTargetYAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensIntensityOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### FreeformLens.FreeformLensIntensityOrientationAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## FreestyleCircularLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.FreestyleCircularLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.FreestyleCircularLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.FreestyleCircularLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.FreestyleCircularLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.FreestyleCircularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleFreestyle Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.FreestyleCircularLens.FreestyleCircularLensGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.FreestyleCircularLens.FreestyleCircularLensTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### FreestyleCircularLens.FreestyleCircularLensGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### FreestyleCircularLens.FreestyleCircularLensTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## FreestyleCircularSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.FreestyleCircularSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.FreestyleCircularSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.FreestyleCircularSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.FreestyleCircularSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.FreestyleCircularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleFreestyle Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.FreestyleCircularSurface.FreestyleCircularSurfaceGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.FreestyleCircularSurface.FreestyleCircularSurfaceTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### FreestyleCircularSurface.FreestyleCircularSurfaceGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### FreestyleCircularSurface.FreestyleCircularSurfaceTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## FreestyleRectangularLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.FreestyleRectangularLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.FreestyleRectangularLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.FreestyleRectangularLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.FreestyleRectangularLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.FreestyleRectangularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleFreestyle Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.FreestyleRectangularLens.FreestyleRectangularLensGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.FreestyleRectangularLens.FreestyleRectangularLensTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### FreestyleRectangularLens.FreestyleRectangularLensGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### FreestyleRectangularLens.FreestyleRectangularLensTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## FreestyleRectangularSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.FreestyleRectangularSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.FreestyleRectangularSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.FreestyleRectangularSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.FreestyleRectangularSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.FreestyleRectangularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleFreestyle Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.FreestyleRectangularSurface.FreestyleRectangularSurfaceGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.FreestyleRectangularSurface.FreestyleRectangularSurfaceTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### FreestyleRectangularSurface.FreestyleRectangularSurfaceGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### FreestyleRectangularSurface.FreestyleRectangularSurfaceTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## HoneycombLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.HoneycombLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.HoneycombLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.HoneycombLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.HoneycombLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.HoneycombLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleHoneycomb Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.HoneycombLens.HoneycombLensGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.HoneycombLens.HoneycombLensTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### HoneycombLens.HoneycombLensGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### HoneycombLens.HoneycombLensTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## HUDOD + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.HUDOD Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.HUDOD Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.HUDOD Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.HUDOD Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.HUDOD CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +UpdateAdvancedParameters | Call the 'Update all parameters' command. Returns 'false' if this action is unavailable in the current state of the object. | `bool UpdateAdvancedParameters()` +GetResultFilePaths | Get the list of paths of all HUD Optical Design resulting files | System.String[] GetResultFilePaths()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +VehicleAxis | Link attribute | `SpeosDes.HUDOD.HUDODVehicleAxis VehicleAxis` +ReverseVehiculeAxisDirection | boolean attribute | `bool ReverseVehiculeAxisDirection` +TopAxis | Link attribute | `SpeosDes.HUDOD.HUDODTopAxis TopAxis` +ReverseTopAxisDirection | boolean attribute | `bool ReverseTopAxisDirection` +ManufacturingX | Number attribute | `int ManufacturingX` +ManufacturingXText | Number attribute (as text) | `string ManufacturingXText` +ManufacturingY | Number attribute | `int ManufacturingY` +ManufacturingYText | Number attribute (as text) | `string ManufacturingYText` +EyeboxCenter | Link attribute | `SpeosDes.HUDOD.HUDODEyeboxCenter EyeboxCenter` +EyeboxOrientationType | Enum attribute | `SpeosDes.HUDOD.EnumEyeboxOrientationType EyeboxOrientationType` +EyeboxOrientationTypeIndex | Enum attribute (as index) | `int EyeboxOrientationTypeIndex` +EBHorizontalSize | Number attribute | `double EBHorizontalSize` +EBHorizontalSizeText | Number attribute (as text) | `string EBHorizontalSizeText` +EBHorizontalSampling | Number attribute | `int EBHorizontalSampling` +EBHorizontalSamplingText | Number attribute (as text) | `string EBHorizontalSamplingText` +EBHorizontalResolution | Number attribute | `double EBHorizontalResolution` +EBHorizontalResolutionText | Number attribute (as text) | `string EBHorizontalResolutionText` +EBVerticalSize | Number attribute | `double EBVerticalSize` +EBVerticalSizeText | Number attribute (as text) | `string EBVerticalSizeText` +EBVerticalSampling | Number attribute | `int EBVerticalSampling` +EBVerticalSamplingText | Number attribute (as text) | `string EBVerticalSamplingText` +EBVerticalResolution | Number attribute | `double EBVerticalResolution` +EBVerticalResolutionText | Number attribute (as text) | `string EBVerticalResolutionText` +EyeboxConfigPositionDirectionType | Enum attribute | `SpeosDes.HUDOD.EnumEyeboxConfigPositionDirectionType EyeboxConfigPositionDirectionType` +EyeboxConfigPositionDirectionTypeIndex | Enum attribute (as index) | `int EyeboxConfigPositionDirectionTypeIndex` +EBConfigurations | Children attribute | `SpeosDes.HUDOD.HUDODEBConfigurations EBConfigurations` +TIVirtualImageDistance | Number attribute | `double TIVirtualImageDistance` +TIVirtualImageDistanceText | Number attribute (as text) | `string TIVirtualImageDistanceText` +TILookOverAngle | Number attribute | `double TILookOverAngle` +TILookOverAngleText | Number attribute (as text) | `string TILookOverAngleText` +TILookDownAngle | Number attribute | `double TILookDownAngle` +TILookDownAngleText | Number attribute (as text) | `string TILookDownAngleText` +TargetImageModeType | Enum attribute | `SpeosDes.HUDOD.EnumTargetImageModeType TargetImageModeType` +TargetImageModeTypeIndex | Enum attribute (as index) | `int TargetImageModeTypeIndex` +TIHorizontalSize | Number attribute | `double TIHorizontalSize` +TIHorizontalSizeText | Number attribute (as text) | `string TIHorizontalSizeText` +TIVerticalSize | Number attribute | `double TIVerticalSize` +TIVerticalSizeText | Number attribute (as text) | `string TIVerticalSizeText` +TIHorizontalFOV | Number attribute | `double TIHorizontalFOV` +TIHorizontalFOVText | Number attribute (as text) | `string TIHorizontalFOVText` +TIVerticalFOV | Number attribute | `double TIVerticalFOV` +TIVerticalFOVText | Number attribute (as text) | `string TIVerticalFOVText` +WindshieldInnerSurface | Link attribute | `SpeosDes.HUDOD.HUDODWindshieldInnerSurface WindshieldInnerSurface` +Projectors | Children attribute | `SpeosDes.HUDOD.HUDODProjectors Projectors` +PGUHorizontalSampling | Number attribute | `int PGUHorizontalSampling` +PGUHorizontalSamplingText | Number attribute (as text) | `string PGUHorizontalSamplingText` +PGUVerticalSampling | Number attribute | `int PGUVerticalSampling` +PGUVerticalSamplingText | Number attribute (as text) | `string PGUVerticalSamplingText` +PGUCharacteristicsType | Enum attribute | `SpeosDes.HUDOD.EnumPGUCharacteristicsType PGUCharacteristicsType` +PGUCharacteristicsTypeIndex | Enum attribute (as index) | `int PGUCharacteristicsTypeIndex` +PGUHorizontalSize | Number attribute | `double PGUHorizontalSize` +PGUHorizontalSizeText | Number attribute (as text) | `string PGUHorizontalSizeText` +PGUHorizontalResolution | Number attribute | `int PGUHorizontalResolution` +PGUHorizontalResolutionText | Number attribute (as text) | `string PGUHorizontalResolutionText` +PGUVerticalSize | Number attribute | `double PGUVerticalSize` +PGUVerticalSizeText | Number attribute (as text) | `string PGUVerticalSizeText` +PGUVerticalResolution | Number attribute | `int PGUVerticalResolution` +PGUVerticalResolutionText | Number attribute (as text) | `string PGUVerticalResolutionText` +AdvancedParameters | Access the HUD Optical Design dynamic parameters | `SpeosDes.HUDOD.DynamicParametersAttribute AdvancedParameters` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### HUDOD.HUDODVehicleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HUDOD.HUDODTopAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HUDOD.HUDODEyeboxCenter + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HUDOD.HUDODEBConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.EyeboxConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.EyeboxConfiguration Item` + +### HUDOD.HUDODWindshieldInnerSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HUDOD.HUDODProjectors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.HUDProjectorElement AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.HUDProjectorElement Item` + +### HUDOD.DynamicParametersAttribute + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | HUD Optical Design dynamic parameters enumerator | `IEnumerator GetEnumerator()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Item | HUD Optical Design dynamic parameters, get by index operator | `double Item` + +## HUDProjectorElement + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.HUDProjectorElement Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Name | string attribute | `string Name` +ProjectorType | Enum attribute | `SpeosDes.HUDProjectorElement.EnumProjectorType ProjectorType` +ProjectorTypeIndex | Enum attribute (as index) | `int ProjectorTypeIndex` +Distance | Number attribute | `double Distance` +DistanceText | Number attribute (as text) | `string DistanceText` +HorizontalAngle | Number attribute | `double HorizontalAngle +HorizontalAngleText | Number attribute (as text) | `string HorizontalAngleText` +MultiConfig | boolean attribute | `bool MultiConfig` +VerticalAngle | Number attribute | `double VerticalAngle` +VerticalAngleText | Number attribute (as text) | `string VerticalAngleText` + +## LightGuide + +### Method + +Name | Description | Syntax +--- | --- | --- +GetStartRadiusTypePossibleValues | string list attribute: List possible values | `IEnumerable GetStartRadiusTypePossibleValues()` +GetEndRadiusTypePossibleValues | string list attribute: List possible values | `IEnumerable GetEndRadiusTypePossibleValues()` +GetMillingTypePossibleValues | string list attribute: List possible values | `IEnumerable GetMillingTypePossibleValues()` +GetBottomPrismMillingTypePossibleValues | string list attribute: List possible values | `IEnumerable GetBottomPrismMillingTypePossibleValues()` +ExportAsCSVFile | | `void ExportAsCSVFile(string csvFilePath)` +Clone | Create a copy of this object in the active context | `SpeosDes.LightGuide Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.LightGuide CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetStepTypePossibleValues | string list attribute: List possible values | `IEnumerable GetStepTypePossibleValues()` +GetLengthTypePossibleValues | string list attribute: List possible values | `IEnumerable GetLengthTypePossibleValues()` +GetTrimmingRatioTypePossibleValues | string list attribute: List possible values | `IEnumerable GetTrimmingRatioTypePossibleValues()` +GetPeakTrimmingRatioTypePossibleValues | string list attribute: List possible values | `IEnumerable GetPeakTrimmingRatioTypePossibleValues()` +GetOffsetTypePossibleValues | string list attribute: List possible values | `IEnumerable GetOffsetTypePossibleValues()` +GetWidthTypePossibleValues | string list attribute: List possible values | `IEnumerable GetWidthTypePossibleValues()` +GetStartAngleTypePossibleValues | string list attribute: List possible values | `IEnumerable GetStartAngleTypePossibleValues()` +GetEndAngleTypePossibleValues | string list attribute: List possible values | `IEnumerable GetEndAngleTypePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.LightGuide Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.LightGuide Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.LightGuide Create()` + +### Property + +Name | Description | Syntax +--- | --- | --- +GuideCurve | Links attribute | `SpeosDes.LightGuide.LightGuideGuideCurve GuideCurve` +ReverseGuideCurveDirection | boolean attribute | `bool ReverseGuideCurveDirection` +MultipleOpticalAxis | Children attribute | `SpeosDes.LightGuide.LightGuideMultipleOpticalAxis MultipleOpticalAxis` +BodyType | Enum attribute | `SpeosDes.LightGuide.EnumBodyType BodyType` +BodyTypeIndex | Enum attribute (as index) | `int BodyTypeIndex` +BodyProfileDiameter | Number attribute | `double BodyProfileDiameter` +BodyProfileDiameterText | Number attribute (as text) | `string BodyProfileDiameterText` +ExtraBodyHeight | Number attribute | `double ExtraBodyHeight` +ExtraBodyHeightText | Number attribute (as text) | `string ExtraBodyHeightText` +BodyProfile | Number attribute | `SpeosDes.LightGuide.LightGuideBodyProfile BodyProfile` +PrismsOrientationType | Enum attribute | `SpeosDes.LightGuide.EnumPrismsOrientationType PrismsOrientationType` +PrismsOrientationTypeIndex | Enum attribute (as index) | `int PrismsOrientationTypeIndex` +OpticalAxis | Link attribute | `SpeosDes.LightGuide.LightGuideOpticalAxis OpticalAxis` +ReverseOpticalAxisDirection | boolean attribute | `bool ReverseOpticalAxisDirection` +OrientationSurface | Link attribute | `SpeosDes.LightGuide.LightGuideOrientationSurface OrientationSurface` +PrismsOperationType | Enum attribute | `SpeosDes.LightGuide.EnumPrismsOperationType PrismsOperationType` +PrismsOperationTypeIndex | Enum attribute (as index) | `int PrismsOperationTypeIndex` +RefractiveIndex | Number attribute | `double RefractiveIndex` +RefractiveIndexText | Number attribute (as text) | `string RefractiveIndexText` +DistancesType | Enum attribute | `SpeosDes.LightGuide.EnumDistancesType DistancesType` +DistancesTypeIndex | Enum attribute (as index) | `int DistancesTypeIndex` +ProjectionAxis | Link attribute | `SpeosDes.LightGuide.LightGuideProjectionAxis ProjectionAxis` +DistanceStart | Number attribute | `double DistanceStart` +DistanceStartText | Number attribute (as text) | `string DistanceStartText` +DistanceEnd | Number attribute | `double DistanceEnd` +DistanceEndText | Number attribute (as text) | `string DistanceEndText` +StepType | string list selection attribute | `string StepType` +StepValue | Number attribute | `double StepValue` +StepValueText | Number attribute (as text) | `string StepValueText` +StepConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideStepConfigurations StepConfigurations` +LengthType | string list selection attribute | `string LengthType` +LengthValue | Number attribute | `double LengthValue` +LengthValueText | Number attribute (as text) | `string LengthValueText` +LengthConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideLengthConfigurations LengthConfigurations` +TrimmingRatioType | string list selection attribute | `string TrimmingRatioType` +TrimmingRatioValue | Number attribute | `double TrimmingRatioValue` +TrimmingRatioValueText | Number attribute (as text) | `string TrimmingRatioValueText` +TrimmingRatioConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideTrimmingRatioConfigurations TrimmingRatioConfigurations` +PeakTrimmingRatioType | string list selection attribute | `string PeakTrimmingRatioType` +PeakTrimmingRatioValue | Number attribute | `double PeakTrimmingRatioValue` +PeakTrimmingRatioValueText | Number attribute (as text) | `string PeakTrimmingRatioValueText` +PeakTrimmingRatioConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuidePeakTrimmingRatioConfigurations PeakTrimmingRatioConfigurations` +OffsetType | string list selection attribute | `string OffsetType` +OffsetValue | Number attribute | `double OffsetValue` +OffsetValueText | Number attribute (as text) | `string OffsetValueText` +OffsetConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideOffsetConfigurations OffsetConfigurations` +WidthType | string list selection attribute | `string WidthType` +WidthValue | Number attribute | `double WidthValue` +WidthValueText | Number attribute (as text) | `string WidthValueText` +WidthConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideWidthConfigurations WidthConfigurations` +StartAngleType | string list selection attribute | `string StartAngleType` +StartAngleValue | Number attribute | `double StartAngleValue` +StartAngleValueText | Number attribute (as text) | `string StartAngleValueText` +StartAngleConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideStartAngleConfigurations StartAngleConfigurations` +EndAngleType | string list selection attribute | `string EndAngleType` +EndAngleValue | Number attribute | `double EndAngleValue` +EndAngleValueText | Number attribute (as text) | `string EndAngleValueText` +EndAngleConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideEndAngleConfigurations EndAngleConfigurations` +StartRadiusType | string list selection attribute | `string StartRadiusType` +StartRadiusValue | Number attribute | `double StartRadiusValue` +StartRadiusValueText | Number attribute (as text) | `string StartRadiusValueText` +StartRadiusConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideStartRadiusConfigurations StartRadiusConfigurations` +EndRadiusType | string list selection attribute | `string EndRadiusType` +EndRadiusValue | Number attribute | `double EndRadiusValue` +EndRadiusValueText | Number attribute (as text) | `string EndRadiusValueText` +EndRadiusConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideEndRadiusConfigurations EndRadiusConfigurations` +CSVFile | File attribute | `string CSVFile` +CSVFileFullPath | File attribute (absolute full path) | `string CSVFileFullPath` +MillingType | string list selection attribute | `string MillingType` +MillingValue | Number attribute | `double MillingValue` +MillingValueText | Number attribute (as text) | `string MillingValueText` +MillingConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideMillingConfigurations MillingConfigurations` +BottomPrismMillingType | string list selection attribute | `string BottomPrismMillingType` +BottomPrismMillingValue | Number attribute | `double BottomPrismMillingValue` +BottomPrismMillingValueText | Number attribute (as text) | `string BottomPrismMillingValueText` +BottomPrismMillingConfigurations | Children attribute | `SpeosDes.LightGuide.LightGuideBottomPrismMillingConfigurations BottomPrismMillingConfigurations` +DraftingType | Enum attribute | `SpeosDes.LightGuide.EnumDraftingType DraftingType` +DraftingTypeIndex | Enum attribute (as index) | `int DraftingTypeIndex` +DemoldingOrientation | Link attribute | `SpeosDes.LightGuide.LightGuideDemoldingOrientation DemoldingOrientation` +ReverseDemoldingDirection | boolean attribute | `bool ReverseDemoldingDirection` +DraftAngle | Number attribute | `double DraftAngle` +DraftAngleText | Number attribute (as text) | `string DraftAngleText` +NbPrisms | Number attribute | `int NbPrisms` +NbPrismsText | Number attribute (as text) | `string NbPrismsText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### LightGuide.LightGuideGuideCurve + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### LightGuide.LightGuideMultipleOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.MultipleOpticalAxis AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.MultipleOpticalAxis Item` + +### LightGuide.LightGuideBodyProfile + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### LightGuide.LightGuideOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### LightGuide.LightGuideOrientationSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### LightGuide.LightGuideProjectionAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### LightGuide.LightGuideStepConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideLengthConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideTrimmingRatioConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuidePeakTrimmingRatioConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideOffsetConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideWidthConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideStartAngleConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideEndAngleConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideStartRadiusConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideEndRadiusConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideMillingConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideBottomPrismMillingConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPointConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPointConfiguration Item` + +### LightGuide.LightGuideDemoldingOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## MOS + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.MOS Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.MOS Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.MOS Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.MOS Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.MOS CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +ExportAsCSVFile | | `void ExportAsCSVFile(string csvFilePath)` +ExtractToolingPath | | `void ExtractToolingPath()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +GuideCurve | Links attribute | `SpeosDes.MOS.MOSGuideCurve GuideCurve` +ReverseGuideCurveDirection | boolean attribute | `bool ReverseGuideCurveDirection` +SecondCurve | Links attribute | `SpeosDes.MOS.MOSSecondCurve SecondCurve` +ConstructionType | Enum attribute | `SpeosDes.MOS.EnumConstructionType ConstructionType` +ConstructionTypeIndex | Enum attribute (as index) | `int ConstructionTypeIndex` +OpticalAxis | Link attribute | `SpeosDes.MOS.MOSOpticalAxis OpticalAxis` +ReverseOpticalAxisDirection | boolean attribute | `bool ReverseOpticalAxisDirection` +SupportSurface | Link attribute | `SpeosDes.MOS.MOSSupportSurface SupportSurface` +ProjectionType | Enum attribute | `SpeosDes.MOS.EnumProjectionType ProjectionType` +ProjectionTypeIndex | Enum attribute (as index) | `int ProjectionTypeIndex` +SupportSide | Enum attribute | `SpeosDes.MOS.EnumSupportSide SupportSide` +SupportSideIndex | Enum attribute (as index) | `int SupportSideIndex` +Thickness | Number attribute | `double Thickness` +ThicknessText | Number attribute (as text) | `string ThicknessText` +SideAngle | Number attribute | `double SideAngle` +SideAngleText | Number attribute (as text) | `string SideAngleText` +Radius | Number attribute | `double Radius` +RadiusText | Number attribute (as text) | `string RadiusText` +ControlPoints | Children attribute | `SpeosDes.MOS.MOSControlPoints ControlPoints` +StripesCount | Number attribute | `int StripesCount` +StripesCountText | Number attribute (as text) | `string StripesCountText` +DraftingAxis | Link attribute | `SpeosDes.MOS.MOSDraftingAxis DraftingAxis` +ReverseDraftingAxisDirection | boolean attribute | `bool ReverseDraftingAxisDirection` +DraftingAngle | Number attribute | `double DraftingAngle` +DraftingAngleText | Number attribute (as text) | `string DraftingAngleText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### MOS.MOSGuideCurve + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### MOS.MOSSecondCurve + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### MOS.MOSOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### MOS.MOSSupportSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### MOS.MOSControlPoints + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.MOSControlPoint AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.MOSControlPoint Item` + +### MOS.MOSDraftingAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## MOSControlPoint + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.MOSControlPoint Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Position | Number attribute | `double Position` +PositionText | Number attribute (as text) | `string PositionText` +Depth | Number attribute | `double Depth` +DepthText | Number attribute (as text) | `string DepthText` +Pitch | Number attribute | `double Pitch` +PitchText | Number attribute (as text) | `string PitchText` +TopLength | Number attribute | `double TopLength` +TopLengthText | Number attribute (as text) | `string TopLengthText` +BitShapeStartAngle | Number attribute | `double BitShapeStartAngle` +BitShapeStartAngleText | Number attribute (as text) | `string BitShapeStartAngleText` +BitShapeEndAngle | Number attribute | `double BitShapeEndAngle` +BitShapeEndAngleText | Number attribute (as text) | `string BitShapeEndAngleText` + +## MultipleOpticalAxis + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.MultipleOpticalAxis Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Position | Number attribute | `double Position` +PositionText | Number attribute (as text) | `string PositionText` +OpticalAxis | Link attribute | `SpeosDes.MultipleOpticalAxis.MultipleOpticalAxisOpticalAxis OpticalAxis` +ReverseDirection | boolean attribute | `bool ReverseDirection` + +### MultipleOpticalAxis.MultipleOpticalAxisOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## Node + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.Node Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.Node Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.Node Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.Node Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.Node CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## OpticalFeatureGeneral + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureGeneral Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +GetSourceTypePossibleValues | string list attribute: List possible values | `IEnumerable GetSourceTypePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +SourceType | string list selection attribute | `string SourceType` +SourcePoint | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourcePoint SourcePoint` +SourceBody | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourceBody SourceBody` +SourceDirection | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourceDirection SourceDirection` +ReverseSourceDirection | boolean attribute | `bool ReverseSourceDirection` +SourceRefractiveIndex | Number attribute | `double SourceRefractiveIndex` +SourceRefractiveIndexText | Number attribute (as text) | `string SourceRefractiveIndexText` +SourceFlux | Number attribute | `double SourceFlux` +SourceFluxText | Number attribute (as text) | `string SourceFluxText` +SupportType | Enum attribute | `SpeosDes.OpticalFeatureGeneral.EnumSupportType SupportType` +SupportTypeIndex | Enum attribute (as index) | `int SupportTypeIndex` +SupportBody | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportBody SupportBody` +SupportOrigin | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrigin SupportOrigin` +SupportAxis | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportAxis SupportAxis` +ReverseSupportAxis | boolean attribute | `bool ReverseSupportAxis` +SupportOrientation | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrientation SupportOrientation` +ReverseSupportOrientation | boolean attribute | `bool ReverseSupportOrientation` +SupportOrientationType | Enum attribute | `SpeosDes.OpticalFeatureGeneral.EnumSupportOrientationType SupportOrientationType` +SupportOrientationTypeIndex | Enum attribute (as index) | `int SupportOrientationTypeIndex` +Thickness | Number attribute | `double Thickness` +ThicknessText | Number attribute (as text) | `string ThicknessText` +RefractiveIndex | Number attribute | `double RefractiveIndex` +RefractiveIndexText | Number attribute (as text) | `string RefractiveIndexText` +TargetType | Enum attribute | `SpeosDes.OpticalFeatureGeneral.EnumTargetType TargetType` +TargetTypeIndex | Enum attribute (as index) | `int TargetTypeIndex` +IntegrationDirectionIsReversed | boolean attribute | `bool IntegrationDirectionIsReversed` +XMPTemplateFile | File attribute | `string XMPTemplateFile` +XMPTemplateFileFullPath | File attribute (absolute full path) | `string XMPTemplateFileFullPath` +TargetOrigin | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrigin TargetOrigin` +TargetAxis | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetAxis TargetAxis` +ReverseTargetAxis | boolean attribute | `bool ReverseTargetAxis` +TargetOrientation | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrientation TargetOrientation` +ReverseTargetOrientation | boolean attribute | `bool ReverseTargetOrientation` +ResultViewingDirection | Enum attribute | `SpeosDes.OpticalFeatureGeneral.EnumResultViewingDirection ResultViewingDirection` +ResultViewingDirectionIndex | Enum attribute (as index) | `int ResultViewingDirectionIndex` +ContourBody | Link attribute | `SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralContourBody ContourBody` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSourcePoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSourceBody + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSourceDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSupportBody + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSupportAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralTargetAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalFeatureGeneral.OpticalFeatureGeneralContourBody + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalFeatureManufacturing + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureManufacturing Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +GetDraftingTypePossibleValues | string list attribute: List possible values | `IEnumerable GetDraftingTypePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Sewing | boolean attribute | `bool Sewing` +DraftingType | string list selection attribute | `string DraftingType` +DraftValue | Number attribute | `double DraftValue` +DraftValueText | Number attribute (as text) | `string DraftValueText` +DraftAll | boolean attribute | `bool DraftAll` +AngularDraftValue | Number attribute | `double AngularDraftValue` +AngularDraftValueText | Number attribute (as text) | `string AngularDraftValueText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## OpticalFeatureStyleCircular + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureStyleCircular Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Start | Number attribute | `double Start` +StartText | Number attribute (as text) | `string StartText` +End | Number attribute | `double End` +EndText | Number attribute (as text) | `string EndText` +Step | Number attribute | `double Step` +StepText | Number attribute (as text) | `string StepText` +ShiftType | Enum attribute | `SpeosDes.OpticalFeatureStyleCircular.EnumShiftType ShiftType` +ShiftTypeIndex | Enum attribute (as index) | `int ShiftTypeIndex` +ShiftLength | Number attribute | `double ShiftLength` +ShiftLengthText | Number attribute (as text) | `string ShiftLengthText` +ShiftAngle | Number attribute | `double ShiftAngle` +ShiftAngleText | Number attribute (as text) | `string ShiftAngleText` +Definition | Enum attribute | `SpeosDes.OpticalFeatureStyleCircular.EnumDefinition Definition` +DefinitionIndex | Enum attribute (as index) | `int DefinitionIndex` +Sectors | Number attribute | `int Sectors` +SectorsText | Number attribute (as text) | `string SectorsText` +Angle | Number attribute | `double Angle` +AngleText | Number attribute (as text) | `string AngleText` +CircularEdges | boolean attribute | `bool CircularEdges` +StyleOrigin | Link attribute | `SpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrigin StyleOrigin` +StyleAxis | Link attribute | `SpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleAxis StyleAxis` +ReverseStyleAxis | boolean attribute | `bool ReverseStyleAxis` +StyleOrientation | Link attribute | `SpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrientation StyleOrientation` +ReverseStyleOrientation | boolean attribute | `bool ReverseStyleOrientation` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalFeatureStyleFreestyle + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureStyleFreestyle Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +XCurves | Links attribute | `SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleXCurves XCurves` +YCurves | Links attribute | `SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleYCurves YCurves` +StyleOrigin | Link attribute | `SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrigin StyleOrigin` +StyleAxis | Link attribute | `SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleAxis StyleAxis` +ReverseStyleAxis | boolean attribute | `bool ReverseStyleAxis` +StyleOrientation | Link attribute | `SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrientation StyleOrientation` +ReverseStyleOrientation | boolean attribute | `bool ReverseStyleOrientation` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleXCurves + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleYCurves + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalFeatureStyleHoneycomb + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureStyleHoneycomb Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +Rotation | Number attribute | `double Rotation` +RotationText | Number attribute (as text) | `string RotationText` +Definition | Enum attribute | `SpeosDes.OpticalFeatureStyleHoneycomb.EnumDefinition Definition` +DefinitionIndex | Enum attribute (as index) | `int DefinitionIndex` +SideLength | Number attribute | `double SideLength` +SideLengthText | Number attribute (as text) | `string SideLengthText` +Width | Number attribute | `double Width` +WidthText | Number attribute (as text) | `string WidthText` +StyleOrigin | Link attribute | `SpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrigin StyleOrigin` +StyleAxis | Link attribute | `SpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleAxis StyleAxis` +ReverseStyleAxis | boolean attribute | `bool ReverseStyleAxis` +StyleOrientation | Link attribute | `SpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrientation StyleOrientation` +ReverseStyleOrientation | boolean attribute | `bool ReverseStyleOrientation` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalFeatureStyleRectangular + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureStyleRectangular Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +XAngle | Number attribute | `double XAngle` +XAngleText | Number attribute (as text) | `string XAngleText` +YAngle | Number attribute | `double YAngle` +YAngleText | Number attribute (as text) | `string YAngleText` +Definition | Enum attribute | `SpeosDes.OpticalFeatureStyleRectangular.EnumDefinition Definition` +DefinitionIndex | Enum attribute (as index) | `int DefinitionIndex` +XCount | Number attribute | `int XCount` +XCountText | Number attribute (as text) | `string XCountText` +YCount | Number attribute | `int YCount` +YCountText | Number attribute (as text) | `string YCountText` +XSize | Number attribute | `double XSize` +XSizeText | Number attribute (as text) | `string XSizeText` +YSize | Number attribute | `double YSize` +YSizeText | Number attribute (as text) | `string YSizeText` +StyleOrigin | Link attribute | `SpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrigin StyleOrigin` +StyleAxis | Link attribute | `SpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleAxis StyleAxis` +ReverseStyleAxis | boolean attribute | `bool ReverseStyleAxis` +StyleOrientation | Link attribute | `SpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrientation StyleOrientation` +ReverseStyleOrientation | boolean attribute | `bool ReverseStyleOrientation` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalFeatureStyleStripes + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalFeatureStyleStripes Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Curves | Links attribute | `SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesCurves Curves` +StyleOrigin | Link attribute | `SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrigin StyleOrigin` +StyleAxis | Link attribute | `SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleAxis StyleAxis` +ReverseStyleAxis | boolean attribute | `bool ReverseStyleAxis` +StyleOrientation | Link attribute | `SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrientation StyleOrientation` +ReverseStyleOrientation | boolean attribute | `bool ReverseStyleOrientation` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesCurves + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrigin + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## OpticalGroup + +### Method + +Name | Description | Syntax +--- | --- | --- +AddFaceFromCoordinates | | `void AddFaceFromCoordinates(int xCoordinate, int yCoordinate)` +AddFacesFromXCoordinate | | `void AddFacesFromXCoordinate(int xCoordinate)` +AddFacesFromYCoordinate | | `void AddFacesFromYCoordinate(int yCoordinate)` +GetGroupTypePossibleValues | string list attribute: List possible values | `IEnumerable GetGroupTypePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.OpticalGroup Find(string objectName)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Shift | Number attribute | `double Shift` +ShiftText | Number attribute (as text) | `string ShiftText` +GeometryOrientation | Enum attribute | `SpeosDes.OpticalGroup.EnumGeometryOrientation GeometryOrientation` +GeometryOrientationIndex | Enum attribute (as index) | `int GeometryOrientationIndex` +Focal | Number attribute | `double Focal` +FocalText | Number attribute (as text) | `string FocalText` +ParabolicApproximation | boolean attribute | `bool ParabolicApproximation` +XTiltAngle | Number attribute | `double XTiltAngle` +XTiltAngleText | Number attribute (as text) | `string XTiltAngleText` +YTiltAngle | Number attribute | `double YTiltAngle` +YTiltAngleText | Number attribute (as text) | `string YTiltAngleText` +Angle | Number attribute | `double Angle` +AngleText | Number attribute (as text) | `string AngleText` +XRadius | Number attribute | `double XRadius` +XRadiusText | Number attribute (as text) | `string XRadiusText` +YRadius | Number attribute | `double YRadius` +YRadiusText | Number attribute (as text) | `string YRadiusText` +RadialRadius | Number attribute | `double RadialRadius` +RadialRadiusText | Number attribute (as text) | `string RadialRadiusText` +StartRadius | Number attribute | `double StartRadius` +StartRadiusText | Number attribute (as text) | `string StartRadiusText` +EndRadius | Number attribute | `double EndRadius` +EndRadiusText | Number attribute (as text) | `string EndRadiusText` +Radius | Number attribute | `double Radius` +RadiusText | Number attribute (as text) | `string RadiusText` +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +CenteredOnXSpread | boolean attribute | `bool CenteredOnXSpread` +CenteredOnYSpread | boolean attribute | `bool CenteredOnYSpread` +SmoothingSector | boolean attribute | `bool SmoothingSector` +XCenter | Number attribute | `double XCenter` +XCenterText | Number attribute (as text) | `string XCenterText` +YCenter | Number attribute | `double YCenter` +YCenterText | Number attribute (as text) | `string YCenterText` +SpreadStart | Number attribute | `double SpreadStart` +SpreadStartText | Number attribute (as text) | `string SpreadStartText` +SpreadEnd | Number attribute | `double SpreadEnd` +SpreadEndText | Number attribute (as text) | `string SpreadEndText` +Tilt | Number attribute | `double Tilt` +TiltText | Number attribute (as text) | `string TiltText` +YSize | Number attribute | `double YSize` +YSizeText | Number attribute (as text) | `string YSizeText` +XAngle | Number attribute | `double XAngle` +XAngleText | Number attribute (as text) | `string XAngleText` +XPosition | Number attribute | `double XPosition` +XPositionText | Number attribute (as text) | `string XPositionText` +XPositionMin | Number attribute | `double XPositionMin` +XPositionMinText | Number attribute (as text) | `string XPositionMinText` +XPositionMax | Number attribute | `double XPositionMax` +XPositionMaxText | Number attribute (as text) | `string XPositionMaxText` +XAngleMin | Number attribute | `double XAngleMin` +XAngleMinText | Number attribute (as text) | `string XAngleMinText` +XAngleMax | Number attribute | `double XAngleMax` +XAngleMaxText | Number attribute (as text) | `string XAngleMaxText` +YAngle | Number attribute | `double YAngle` +YAngleText | Number attribute (as text) | `string YAngleText` +YPosition | Number attribute | `double YPosition` +YPositionText | Number attribute (as text) | `string YPositionText` +YPositionMin | Number attribute | `double YPositionMin` +YPositionMinText | Number attribute (as text) | `string YPositionMinText` +YPositionMax | Number attribute | `double YPositionMax` +YPositionMaxText | Number attribute (as text) | `string YPositionMaxText` +YAngleMin | Number attribute | `double YAngleMin` +YAngleMinText | Number attribute (as text) | `string YAngleMinText` +YAngleMax | Number attribute | `double YAngleMax` +YAngleMaxText | Number attribute (as text) | `string YAngleMaxText` +XSpread | Number attribute | `double XSpread` +XSpreadText | Number attribute (as text) | `string XSpreadText` +YSpread | Number attribute | `double YSpread` +YSpreadText | Number attribute (as text) | `string YSpreadText` +AdvancedMode | boolean attribute | `bool AdvancedMode` +SCOHControlPlanes | Children attribute | `SpeosDes.OpticalGroup.OpticalGroupSCOHControlPlanes SCOHControlPlanes` +SCOVControlPlanes | Children attribute | `SpeosDes.OpticalGroup.OpticalGroupSCOVControlPlanes SCOVControlPlanes` +StartAngle | Number attribute | `double StartAngle` +StartAngleText | Number attribute (as text) | `string StartAngleText` +EndAngle | Number attribute | `double EndAngle` +EndAngleText | Number attribute (as text) | `string EndAngleText` +XRadiusPrism | Number attribute | `double XRadiusPrism` +XRadiusPrismText | Number attribute (as text) | `string XRadiusPrismText` +YRadiusPrism | Number attribute | `double YRadiusPrism` +YRadiusPrismText | Number attribute (as text) | `string YRadiusPrismText` +Height | Number attribute | `double Height` +HeightText | Number attribute (as text) | `string HeightText` +FaceList | Links attribute | `SpeosDes.OpticalGroup.OpticalGroupFaceList FaceList` +GroupType | string list selection attribute | `string GroupType` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### OpticalGroup.OpticalGroupSCOHControlPlanes + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPlane AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPlane Item` + +### OpticalGroup.OpticalGroupSCOVControlPlanes + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPlane AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPlane Item` + +### OpticalGroup.OpticalGroupFaceList + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## ParabolicSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.ParabolicSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.ParabolicSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.ParabolicSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.ParabolicSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.ParabolicSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosDes.ParabolicSurface.ParabolicSurfaceOriginPoint OriginPoint` +Axis | Link attribute | `SpeosDes.ParabolicSurface.ParabolicSurfaceAxis Axis` +OrientationAxis | Link attribute | `SpeosDes.ParabolicSurface.ParabolicSurfaceOrientationAxis OrientationAxis` +Size | Number attribute | `double Size` +SizeText | Number attribute (as text) | `string SizeText` +BuildType | Enum attribute | `SpeosDes.ParabolicSurface.EnumBuildType BuildType` +BuildTypeIndex | Enum attribute (as index) | `int BuildTypeIndex` +Focal | Number attribute | `double Focal` +FocalText | Number attribute (as text) | `string FocalText` +FocalOut | Number attribute | `double FocalOut` +FocalOutText | Number attribute (as text) | `string FocalOutText` +PassingPoint | Link attribute | `SpeosDes.ParabolicSurface.ParabolicSurfacePassingPoint PassingPoint` +ReverseOpticalAxis | boolean attribute | `bool ReverseOpticalAxis` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ParabolicSurface.ParabolicSurfaceOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ParabolicSurface.ParabolicSurfaceAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ParabolicSurface.ParabolicSurfaceOrientationAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ParabolicSurface.ParabolicSurfacePassingPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## PER + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.PER Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.PER Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.PER Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.PER Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.PER CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +SourceType | Enum attribute | `SpeosDes.PER.EnumSourceType SourceType` +SourceTypeIndex | Enum attribute (as index) | `int SourceTypeIndex` +SourcePoint | Link attribute | `SpeosDes.PER.PERSourcePoint SourcePoint` +SourceSupport | Link attribute | `SpeosDes.PER.PERSourceSupport SourceSupport` +ImagePoint | Link attribute | `SpeosDes.PER.PERImagePoint ImagePoint` +OrientationAxis | Link attribute | `SpeosDes.PER.PEROrientationAxis OrientationAxis` +ReverseOrientationAxisDirection | boolean attribute | `bool ReverseOrientationAxisDirection` +FocalLength | Number attribute | `double FocalLength` +FocalLengthText | Number attribute (as text) | `string FocalLengthText` +Hole | boolean attribute | `bool Hole` +HoleDiameter | Number attribute | `double HoleDiameter` +HoleDiameterText | Number attribute (as text) | `string HoleDiameterText` +Symmetry | Enum attribute | `SpeosDes.PER.EnumSymmetry Symmetry` +SymmetryIndex | Enum attribute (as index) | `int SymmetryIndex` +AngularSections | Children CustomObjects attribute | `SpeosDes.PER.PERAngularSections AngularSections` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### PER.PERSourcePoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### PER.PERSourceSupport + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### PER.PERImagePoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### PER.PEROrientationAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### PER.PERAngularSections + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.PERAngularSection AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.PERAngularSection Item` +Item | Get child CustomObject by index | `SpeosDes.PERAngularSection Item` + +## PERAngularSection + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.PERAngularSection Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FittingControlPlane | Call the 'Fitting control plane' command. Returns 'false' if this action is unavailable in the current state of the object. | `bool FittingControlPlane()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Angle | Number attribute | `double Angle` +AngleText | Number attribute (as text) | `string AngleText` +ControlPlanes | Children attribute | `SpeosDes.PERAngularSection.PERAngularSectionControlPlanes ControlPlanes` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### PERAngularSection.PERAngularSectionControlPlanes + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosDes.ControlPlane AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ControlPlane Item` + +## PostProcessing + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.PostProcessing Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.PostProcessing Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.PostProcessing Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.PostProcessing Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.PostProcessing CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +AssociatedFeature | Link attribute | `SpeosDes.PostProcessing.PostProcessingAssociatedFeature AssociatedFeature` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### PostProcessing.PostProcessingAssociatedFeature + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## ProjectionLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.ProjectionLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.ProjectionLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.ProjectionLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.ProjectionLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.ProjectionLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +FocalPoint | Link attribute | `SpeosDes.ProjectionLens.ProjectionLensFocalPoint FocalPoint` +OpticalAxis | Link attribute | `SpeosDes.ProjectionLens.ProjectionLensOpticalAxis OpticalAxis` +OpticalAxisReverse | boolean attribute | `bool OpticalAxisReverse` +BackFocalLength | Number attribute | `double BackFocalLength` +BackFocalLengthText | Number attribute (as text) | `string BackFocalLengthText` +BackFaceType | Enum attribute | `SpeosDes.ProjectionLens.EnumBackFaceType BackFaceType` +BackFaceTypeIndex | Enum attribute (as index) | `int BackFaceTypeIndex` +FrontFaceType | Enum attribute | `SpeosDes.ProjectionLens.EnumFrontFaceType FrontFaceType` +FrontFaceTypeIndex | Enum attribute (as index) | `int FrontFaceTypeIndex` +ZernikeOrientation | Link attribute | `SpeosDes.ProjectionLens.ProjectionLensZernikeOrientation ZernikeOrientation` +ZernikeOrientationReverse | boolean attribute | `bool ZernikeOrientationReverse` +ThicknessSetType | Enum attribute | `SpeosDes.ProjectionLens.EnumThicknessSetType ThicknessSetType` +ThicknessSetTypeIndex | Enum attribute (as index) | `int ThicknessSetTypeIndex` +EdgeThickness | Number attribute | `double EdgeThickness` +EdgeThicknessText | Number attribute (as text) | `string EdgeThicknessText` +EdgeThicknessOut | Number attribute | `double EdgeThicknessOut` +EdgeThicknessOutText | Number attribute (as text) | `string EdgeThicknessOutText` +LensThickness | Number attribute | `double LensThickness` +LensThicknessText | Number attribute (as text) | `string LensThicknessText` +LensThicknessOut | Number attribute | `double LensThicknessOut` +LensThicknessOutText | Number attribute (as text) | `string LensThicknessOutText` +ConstructionType | Enum attribute | `SpeosDes.ProjectionLens.EnumConstructionType ConstructionType` +ConstructionTypeIndex | Enum attribute (as index) | `int ConstructionTypeIndex` +CustomRevolution | boolean attribute | `bool CustomRevolution` +RevolutionOriginPoint | Link attribute | `SpeosDes.ProjectionLens.ProjectionLensRevolutionOriginPoint RevolutionOriginPoint` +RevolutionAxis | Link attribute | `SpeosDes.ProjectionLens.ProjectionLensRevolutionAxis RevolutionAxis` +RevolutionAxisReverse | boolean attribute | `bool RevolutionAxisReverse` +ExtrusionAxis | Link attribute | `SpeosDes.ProjectionLens.ProjectionLensExtrusionAxis ExtrusionAxis` +ExtrusionAxisReverse | boolean attribute | `bool ExtrusionAxisReverse` +ExtrusionStart | Number attribute | `double ExtrusionStart` +ExtrusionStartText | Number attribute (as text) | `string ExtrusionStartText` +ExtrusionEnd | Number attribute | `double ExtrusionEnd` +ExtrusionEndText | Number attribute (as text) | `string ExtrusionEndText` +RevolutionStart | Number attribute | `double RevolutionStart` +RevolutionStartText | Number attribute (as text) | `string RevolutionStartText` +RevolutionEnd | Number attribute | `double RevolutionEnd` +RevolutionEndText | Number attribute (as text) | `string RevolutionEndText` +BackFaceApertureDiameter | Number attribute | `double BackFaceApertureDiameter` +BackFaceApertureDiameterText | Number attribute (as text) | `string BackFaceApertureDiameterText` +BackRadiusCurvature | Number attribute | `double BackRadiusCurvature` +BackRadiusCurvatureText | Number attribute (as text) | `string BackRadiusCurvatureText` +BackConicConstant | Number attribute | `double BackConicConstant` +BackConicConstantText | Number attribute (as text) | `string BackConicConstantText` +BackFaceRefractiveIndex | Number attribute | `double BackFaceRefractiveIndex` +BackFaceRefractiveIndexText | Number attribute (as text) | `string BackFaceRefractiveIndexText` +BackFaceFresnelMode | Enum attribute | `SpeosDes.ProjectionLens.EnumBackFaceFresnelMode BackFaceFresnelMode` +BackFaceFresnelModeIndex | Enum attribute (as index) | `int BackFaceFresnelModeIndex` +BackFaceStep | Number attribute | `double BackFaceStep` +BackFaceStepText | Number attribute (as text) | `string BackFaceStepText` +BackFaceHeight | Number attribute | `double BackFaceHeight` +BackFaceHeightText | Number attribute (as text) | `string BackFaceHeightText` +BackFaceDraftAngle | Number attribute | `double BackFaceDraftAngle` +BackFaceDraftAngleText | Number attribute (as text) | `string BackFaceDraftAngleText` +BackFaceAsphericals | Children attribute | `SpeosDes.ProjectionLens.ProjectionLensBackFaceAsphericals BackFaceAsphericals` +BackFaceZernikeCoefficients | Children attribute | `SpeosDes.ProjectionLens.ProjectionLensBackFaceZernikeCoefficients BackFaceZernikeCoefficients` +FrontFaceApertureDiameter | Number attribute | `double FrontFaceApertureDiameter` +FrontFaceApertureDiameterText | Number attribute (as text) | `string FrontFaceApertureDiameterText` +FrontRadiusCurvature | Number attribute | `double FrontRadiusCurvature` +FrontRadiusCurvatureText | Number attribute (as text) | `string FrontRadiusCurvatureText` +FrontConicConstant | Number attribute | `double FrontConicConstant` +FrontConicConstantText | Number attribute (as text) | `string FrontConicConstantText` +FrontFaceRefractiveIndex | Number attribute | `double FrontFaceRefractiveIndex` +FrontFaceRefractiveIndexText | Number attribute (as text) | `string FrontFaceRefractiveIndexText` +FrontFaceFresnelMode | Enum attribute | `SpeosDes.ProjectionLens.EnumFrontFaceFresnelMode FrontFaceFresnelMode` +FrontFaceFresnelModeIndex | Enum attribute (as index) | `int FrontFaceFresnelModeIndex` +FrontFaceStep | Number attribute | `double FrontFaceStep` +FrontFaceStepText | Number attribute (as text) | `string FrontFaceStepText` +FrontFaceHeight | Number attribute | `double FrontFaceHeight` +FrontFaceHeightText | Number attribute (as text) | `string FrontFaceHeightText` +FrontFaceDraftAngle | Number attribute | `double FrontFaceDraftAngle` +FrontFaceDraftAngleText | Number attribute (as text) | `string FrontFaceDraftAngleText` +FrontFaceAsphericals | Children attribute | `SpeosDes.ProjectionLens.ProjectionLensFrontFaceAsphericals FrontFaceAsphericals` +FrontFaceZernikeCoefficients | Children attribute | `SpeosDes.ProjectionLens.ProjectionLensFrontFaceZernikeCoefficients FrontFaceZernikeCoefficients` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ProjectionLens.ProjectionLensFocalPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ProjectionLens.ProjectionLensOpticalAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ProjectionLens.ProjectionLensZernikeOrientation + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ProjectionLens.ProjectionLensRevolutionOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ProjectionLens.ProjectionLensRevolutionAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ProjectionLens.ProjectionLensExtrusionAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ProjectionLens.ProjectionLensBackFaceAsphericals + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.Aspherics Item` + +### ProjectionLens.ProjectionLensBackFaceZernikeCoefficients + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ZernikeCoefficient Item` + +### ProjectionLens.ProjectionLensFrontFaceAsphericals + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.Aspherics Item` + +### ProjectionLens.ProjectionLensFrontFaceZernikeCoefficients + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosDes.ZernikeCoefficient Item` + +## RectangularLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.RectangularLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.RectangularLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.RectangularLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.RectangularLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.RectangularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleRectangular Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.RectangularLens.RectangularLensGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.RectangularLens.RectangularLensTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### RectangularLens.RectangularLensGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### RectangularLens.RectangularLensTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## RectangularSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.RectangularSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.RectangularSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.RectangularSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.RectangularSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.RectangularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleRectangular Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.RectangularSurface.RectangularSurfaceGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.RectangularSurface.RectangularSurfaceTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### RectangularSurface.RectangularSurfaceGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### RectangularSurface.RectangularSurfaceTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## ResultHOD + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.ResultHOD Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +ResultType | Enum attribute | `SpeosDes.ResultHOD.EnumResultType ResultType` +ResultTypeIndex | Enum attribute (as index) | `int ResultTypeIndex` +FullPath | Get the result file full path | `string FullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## StripesLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.StripesLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.StripesLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.StripesLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.StripesLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.StripesLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleStripes Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.StripesLens.StripesLensGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.StripesLens.StripesLensTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### StripesLens.StripesLensGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### StripesLens.StripesLensTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## StripesSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.StripesSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.StripesSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.StripesSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.StripesSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.StripesSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddGroup | Call the 'AddGroup' command. | `void AddGroup()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Style | Child CustomObject attribute | `SpeosDes.OpticalFeatureStyleStripes Style` +General | Child CustomObject attribute | `SpeosDes.OpticalFeatureGeneral General` +Groups | Children CustomObjects attribute | `SpeosDes.StripesSurface.StripesSurfaceGroups Groups` +TirLens | Children CustomObjects attribute | `SpeosDes.StripesSurface.StripesSurfaceTirLens TirLens` +Manufacturing | Child CustomObject attribute | `SpeosDes.OpticalFeatureManufacturing Manufacturing` +ExcelFile | File attribute | `Fou.Utils.ValueObjects.FilePath ExcelFile` +ExcelFileFullPath | File attribute (absolute full path) | `string ExcelFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### StripesSurface.StripesSurfaceGroups + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.OpticalGroup AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` +Item | Get child CustomObject by index | `SpeosDes.OpticalGroup Item` + +### StripesSurface.StripesSurfaceTirLens + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosDes.TIRLens AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` +Item | Get child CustomObject by index | `SpeosDes.TIRLens Item` + +## TIRLens + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosDes.TIRLens Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosDes.TIRLens Create(object parent)` +Create | Create a new object in the active context | `SpeosDes.TIRLens Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosDes.TIRLens Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosDes.TIRLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +BuildType | Enum attribute | `SpeosDes.TIRLens.EnumBuildType BuildType` +BuildTypeIndex | Enum attribute (as index) | `int BuildTypeIndex` +Source | Link attribute | `SpeosDes.TIRLens.TIRLensSource Source` +SupportPlane | Link attribute | `SpeosDes.TIRLens.TIRLensSupportPlane SupportPlane` +InputRadius | Number attribute | `double InputRadius` +InputRadiusText | Number attribute (as text) | `string InputRadiusText` +Depth | Number attribute | `double Depth` +DepthText | Number attribute (as text) | `string DepthText` +DraftAngle | Number attribute | `double DraftAngle` +DraftAngleText | Number attribute (as text) | `string DraftAngleText` +SupportThickness | Number attribute | `double SupportThickness` +SupportThicknessText | Number attribute (as text) | `string SupportThicknessText` +RefractiveIndex | Number attribute | `double RefractiveIndex` +RefractiveIndexText | Number attribute (as text) | `string RefractiveIndexText` +Thickness | Number attribute | `double Thickness` +ThicknessText | Number attribute (as text) | `string ThicknessText` +ThicknessOut | Number attribute | `double ThicknessOut` +ThicknessOutText | Number attribute (as text) | `string ThicknessOutText` +OutputRadius | Number attribute | `double OutputRadius` +OutputRadiusText | Number attribute (as text) | `string OutputRadiusText` +OutputRadiusOut | Number attribute | `double OutputRadiusOut` +OutputRadiusOutText | Number attribute (as text) | `string OutputRadiusOutText` +Focal | Number attribute | `double Focal` +FocalText | Number attribute (as text) | `string FocalText` +ReverseDirection | boolean attribute | `bool ReverseDirection` +Spread | Number attribute | `double Spread` +SpreadText | Number attribute (as text) | `string SpreadText` +SpreadBehavior | Enum attribute | `SpeosDes.TIRLens.EnumSpreadBehavior SpreadBehavior` +SpreadBehaviorIndex | Enum attribute (as index) | `int SpreadBehaviorIndex` +SpreadControl | Number attribute | `double SpreadControl` +SpreadControlText | Number attribute (as text) | `string SpreadControlText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### TIRLens.TIRLensSource + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### TIRLens.TIRLensSupportPlane + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## ZernikeCoefficient + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosDes.ZernikeCoefficient Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Index | Number attribute | `int Index` +IndexText | Number attribute (as text) | `string IndexText` +Value | Number attribute | `double Value +ValueText | Number attribute (as text) | `string ValueText` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/des-example/des_script_examples.md b/2025R1_Test/speos/articles/des/des-example/des_script_examples.md new file mode 100644 index 0000000000..ef33517318 --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/des_script_examples.md @@ -0,0 +1,10 @@ +# SpeosDes script examples + +The following section provides you with a list of script samples to help you create your own script. + + - [LightGuide – Exporting prism parameters as CSV file](method_lightguide_exporting_prism_parameters_csv.md) + - [LightGuide – Defining control points to create parameters variation along the guide](method_lightguide_defining_control_points_variation.md) + - [ProjectionLens – Getting/setting aspheric parameters](method_projectionlens_getting_setting_aspheric_parameters.md) + - [PERAngularSection – Managing the beam spread of a poly ellipsoidal reflector](method_perangularsection_managing_beam_spread_per.md) + - [PERAngularSection – Using the FittingControlPlane method](method_perangularsection_fittingcontrolplane.md) + - [HUDOD – Getting/setting advanced parameters to improve HUD system](method_hudod_getting_setting_advanced_parameters.md) diff --git a/2025R1_Test/speos/articles/des/des-example/method_hudod_getting_setting_advanced_parameters.md b/2025R1_Test/speos/articles/des/des-example/method_hudod_getting_setting_advanced_parameters.md new file mode 100644 index 0000000000..b54d868e2f --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/method_hudod_getting_setting_advanced_parameters.md @@ -0,0 +1,13 @@ +# HUDOD – Getting/setting advanced parameters to improve HUD system + +This page presents you an example on how to get/set HUD Optical Design Advanced Parameters to optimize, correct or adjust the HUD system. + +**AdvancedParameters** allows you to get/set the following dynamics parameters: PGU Usage, Curvature Balance, Mirror Size Ratio, Stopping Criterion. + +```ironpython +hod = SpeosDes.HUDOD.Find("HUD Optical Design.1") +hod.AdvancedParameters['Mirror size ratio'] = 1.4 +print hod.AdvancedParameters['Curvature Balance'] +for key in hod.AdvancedParameters: + print key +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/des-example/method_lightguide_defining_control_points_variation.md b/2025R1_Test/speos/articles/des/des-example/method_lightguide_defining_control_points_variation.md new file mode 100644 index 0000000000..767bbca3cd --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/method_lightguide_defining_control_points_variation.md @@ -0,0 +1,59 @@ +# LightGuide – Defining control points to create parameters variation along the guide + +This page presents you an example on how to define Control Points to create parameter variation along the guide curve of a Light Guide. + +```ironpython +# Light Guide +LightGuide1 = SpeosDes.LightGuide.Create() + +# Guide curve +Curve_LightGuide = GetRootPart().Curves[4] +LightGuide1.GuideCurve.Set(Curve_LightGuide) + +# Body +LightGuide1.BodyProfileDiameter = 5 + +# Prisms orientation +X_Axis = GetRootPart().Curves[1] +LightGuide1.OpticalAxis.Set(X_Axis) + +LightGuide1.PrismsOperationType = SpeosDes.LightGuide.EnumPrismsOperationType.Hybrid +LightGuide1.ReverseOpticalAxisDirection = False + +# Distances +LightGuide1.DistancesType = SpeosDes.LightGuide.EnumDistancesType.Curvilinear +LightGuide1.DistanceStart = 2 +LightGuide1.DistanceEnd = 2 + +# Prism geometries +LightGuide1.StepType = "Control points" + +stepConfig = LightGuide1.StepConfigurations +print "Number of configurations: " + str(stepConfig.Count) + +for config in LightGuide1.StepConfigurations: + print "Position: " + str(config.Position) + ", Value: " + str(config.Value) + +controlPoint = LightGuide1.StepConfigurations.AddNew(0) +controlPoint.Position = 50 +controlPoint.Value = 3 + +print "After adding new configuration: " +for config in LightGuide1.StepConfigurations: + print "Position: " + str(config.Position) + ", Value: " + str(config.Value) + +# Add after the index +child = LightGuide1.StepConfigurations.AddNew(0) +child.Position = 30 +child.Value = 4 + +LightGuide1.OffsetType = "Constant" +LightGuide1.OffsetValue = 4 + +LightGuide1.StartAngleType = "Input file" +LightGuide1.EndAngleType = "Automatic" + +LightGuide1.CSVFile = ".\\LightGuide_export.csv" + +LightGuide1.Compute() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/des-example/method_lightguide_exporting_prism_parameters_csv.md b/2025R1_Test/speos/articles/des/des-example/method_lightguide_exporting_prism_parameters_csv.md new file mode 100644 index 0000000000..19cfa8723a --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/method_lightguide_exporting_prism_parameters_csv.md @@ -0,0 +1,41 @@ +# LightGuide – Exporting prism parameters as CSV file + +This page presents you an example on how to export all the prism parameters of a Light Guide as CSV file thanks to the **ExportAsCSVFile** method. + +```ironpython +# Find "Light guide.1" Light Guide +LightGuide1 = SpeosDes.LightGuide.Find("Light guide.1") + +if not LightGuide1 is None: + +# Prism geometries +LightGuide1.StepType = "Control points" + +stepConfig = LightGuide1.StepConfigurations +print "Number of configurations: " + str(stepConfig.Count) +config = 0 +while config < stepConfig.Count: + print "Position: " + str(stepConfig[config].Position) + ", Value: " + str(stepConfig[config].Value) + config += 1 + +controlPoint = LightGuide1.StepConfigurations.AddNew(0) +controlPoint.Position = 50 +controlPoint.Value = 3 + +child = LightGuide1.StepConfigurations.AddNew(0) +child.Position = 30 +child.Value = 4 + +LightGuide1.OffsetType = "Constant" +LightGuide1.OffsetValue = 4 + +LightGuide1.StartAngleType = "Input file" +LightGuide1.EndAngleType = "Automatic" + +LightGuide1.CSVFile = ".\\LightGuide_export.csv" + +LightGuide1.Compute() + +csvFile = currentPath + "\\" + "LightGuide_csv_export.csv" +LightGuide1.ExportAsCSVFile(csvFile) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/des-example/method_perangularsection_fittingcontrolplane.md b/2025R1_Test/speos/articles/des/des-example/method_perangularsection_fittingcontrolplane.md new file mode 100644 index 0000000000..55e1986c38 --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/method_perangularsection_fittingcontrolplane.md @@ -0,0 +1,45 @@ +# PERAngularSection – Using the FittingControlPlane method + +This page presents you an example on how to use the **FittingControlPlane** method with a Poly Ellipsoidal Reflector. + +```ironpython +# Poly Ellipsoidal Reflector + +# Find "Poly Ellipsoidal Reflector.1" Light Guide +perSurface = SpeosDes.PER.Find("Poly Ellipsoidal Reflector.1") + +if not perSurface is None: +perSurface.Symmetry = SpeosDes.PER.EnumSymmetry.SymmetryTo0Plane + +perSurface.Compute() + +perSurface2 = perSurface.Clone() +perSurface2.Compute() + +# Add angular section +perAngularSection = perSurface2.AngularSections.AddNew(0) +perAngularSection.Angle = 55 + +# Add control plane +controlPlane = perAngularSection.ControlPlanes.AddNew() +controlPlane.Defocus = 0 +controlPlane.Position = 15 + +# Check position and defocus values +controlPlanes = perAngularSection.ControlPlanes +for controlPlane in controlPlanes: + print "Control plane position: " + str(controlPlane.Position) + ", defocus: " + str(controlPlane.Defocus) + +fittingWorked = perAngularSection.FittingControlPlane() +print "After fitting control planes" +print "Fitting did work? " + str(fittingWorked) + +for controlPlane in controlPlanes: + print "Control plane position: " + str(controlPlane.Position) + ", defocus: " + str(controlPlane.Defocus) + +perSurface2.Compute() + +perAngularSection = perSurface2.AngularSections[0] +fittingWorked = perAngularSection.FittingControlPlane() +print "Fitting did work? " + str(fittingWorked) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/des-example/method_perangularsection_managing_beam_spread_per.md b/2025R1_Test/speos/articles/des/des-example/method_perangularsection_managing_beam_spread_per.md new file mode 100644 index 0000000000..e0cb442dbd --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/method_perangularsection_managing_beam_spread_per.md @@ -0,0 +1,37 @@ +# PERAngularSection – Managing the beam spread of a poly ellipsoidal reflector + +This page presents you an example on how to define a Control Plane that allows you to drive the overall beam spread for a Poly Ellipsoidal Reflector. + +```ironpython +# Poly Ellipsoidal Reflector +perSurface = SpeosDes.PER.Create() + +perSurface.SourcePoint.Set(GetRootPart().Curves[0]) +perSurface.ImagePoint.Set(GetRootPart().Curves[6]) +perSurface.OrientationAxis.Set(GetRootPart().Curves[3]) +perSurface.Symmetry = SpeosDes.PER.EnumSymmetry.SymmetryTo0Plane + +angularSectionConfig = perSurface.AngularSections +ParsePER(angularSectionConfig) + +# Add angular section +perAngularSection = perSurface.AngularSections.AddNew(0) +perAngularSection.Angle = 55 + +print "After adding an angular section: " + +angularSectionConfig = perSurface.AngularSections +ParsePER(angularSectionConfig) + +# Add control plane +controlPlane = perAngularSection.ControlPlanes.AddNew() +controlPlane.Defocus = 0 +controlPlane.Position = 15 + +print "After adding a control plane: " + +angularSectionConfig = perSurface.AngularSections +ParsePER(angularSectionConfig) + +perSurface.Compute() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/des/des-example/method_projectionlens_getting_setting_aspheric_parameters.md b/2025R1_Test/speos/articles/des/des-example/method_projectionlens_getting_setting_aspheric_parameters.md new file mode 100644 index 0000000000..4dd9649954 --- /dev/null +++ b/2025R1_Test/speos/articles/des/des-example/method_projectionlens_getting_setting_aspheric_parameters.md @@ -0,0 +1,9 @@ +# ProjectionLens – Getting/setting aspheric parameters + +This page presents you an example on how to get/set the aspheric parameters of a Projection Lens. + +```ironpython +pl = SpeosDes.ProjectionLens.Find("TIR Lens.1") +pl.BackFaceAspherics[2] = 2.3 +print pl.BackFaceAspherics[2] +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/docfx.json b/2025R1_Test/speos/articles/docfx.json new file mode 100644 index 0000000000..d57e3c975a --- /dev/null +++ b/2025R1_Test/speos/articles/docfx.json @@ -0,0 +1,13 @@ +{ + "build": { + "globalMetadata": { + "title": "Speos client APIs 2024 R2", + "summary": "", + "version": "2024 R2", + "product": "Speos", + "programming language": "IronPython", + "product collection": "Optics", + "physics": "Optics" + } + } + } diff --git a/2025R1_Test/speos/articles/images/186802.png b/2025R1_Test/speos/articles/images/186802.png new file mode 100644 index 0000000000..bbd20f568d Binary files /dev/null and b/2025R1_Test/speos/articles/images/186802.png differ diff --git a/2025R1_Test/speos/articles/images/186803.png b/2025R1_Test/speos/articles/images/186803.png new file mode 100644 index 0000000000..5f434974f1 Binary files /dev/null and b/2025R1_Test/speos/articles/images/186803.png differ diff --git a/2025R1_Test/speos/articles/images/UG_ASP_images_(interface)_API_V20_Beta.png b/2025R1_Test/speos/articles/images/UG_ASP_images_(interface)_API_V20_Beta.png new file mode 100644 index 0000000000..aaa8006659 Binary files /dev/null and b/2025R1_Test/speos/articles/images/UG_ASP_images_(interface)_API_V20_Beta.png differ diff --git a/2025R1_Test/speos/articles/sim/client-speos-sim.md b/2025R1_Test/speos/articles/sim/client-speos-sim.md new file mode 100644 index 0000000000..91c78ec21f --- /dev/null +++ b/2025R1_Test/speos/articles/sim/client-speos-sim.md @@ -0,0 +1,7772 @@ +# SpeosSim + +## Command + +This section details all commands of the Speos Sim client API. + +### Static method + +This section lists all static methods. + +Name | Description | Syntax +--- | --- | --- +SetActiveSelection | Set the active selection from a collection of DocObjects | `void SetActiveSelection(ICollection selectedObjects)` +GetSpeosObjectsInActivePart | Get the Speos objects contained in the active Part | `IEnumerable GetSpeosObjectsInActivePart()` +GetErrorStatus | Get the error status of the given object | `string GetErrorStatus(object docObject)` +IsUpToDate | Ask if the given object was modified since its last successful computation | `bool IsUpToDate(object docObject)` +Compute | Perform the computation of an array of objects | `void Compute(System.Object[] selectedObjects)` +Compute | Perform the computation of an array of DocObjects | `void Compute(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Compute | Perform the computation of an array of script objects | `void Compute(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +ComputeOnActiveSelection | Perform the computation of the active selection | `void ComputeOnActiveSelection()` +HpcCompute | Perform the HPC computation of an array of objects | `void HpcCompute(System.Object[] selectedObjects)` +HpcCompute | Perform the HPC computation of an array of DocObjects | `void HpcCompute(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +HpcCompute | Perform the HPC computation of an array of script objects | `void HpcCompute(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +HpcComputeOnActiveSelection | Perform the HPC computation of the active selection | `void HpcComputeOnActiveSelection()` +GpuCompute | Perform the GPU computation of an array of objects | `void GpuCompute(System.Object[] selectedObjects)` +GpuCompute | Perform the GPU computation of an array of DocObjects | `void GpuCompute(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +GpuCompute | Perform the GPU computation of an array of script objects | `void GpuCompute(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +GpuComputeOnActiveSelection | Perform the GPU computation of the active selection | `void GpuComputeOnActiveSelection()` +PreviewCompute | Perform the Preview computation of an array of objects | `void PreviewCompute(System.Object[] selectedObjects)` +PreviewCompute | Perform the Preview computation of an array of DocObjects | `void PreviewCompute(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +PreviewCompute | Perform the Preview computation of an array of script objects | `void PreviewCompute(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +PreviewComputeOnActiveSelection | Perform the Preview computation of the active selection | `void PreviewComputeOnActiveSelection()` +GetOutputFolder | Get the Speos output files directory path for the active context | `string GetOutputFolder()` +GetInputFolder | Get the Speos input files directory path for the active context | `string GetInputFolder()` +ExportFileReferences | Export all Speos file references found in the active document to an Excel file (.xlsx). | `void ExportFileReferences(string xlsxFilePath)` + +## Coefficient + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Index | Number attribute | `int Index` +IndexText | Number attribute (as text) | `string IndexText` +Value | Number attribute | `double Value` +ValueText | Number attribute (as text) | `string ValueText` + +## Component + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.Component Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## Component3DTexture + +### Method + +Name | Description | Syntax +--- | --- | --- +Export | Export to STL | `void Export(string fileName)` +Export | Export to STL | `void Export(string fileName, bool performBooleanOperation)` +GetGeometrySettings | Get the geometry settings (meshing behavior) | `SpeosSim.SimulationSettings GetGeometrySettings()` +SetGeometrySettings | Set the geometry settings (meshing behavior) | `void SetGeometrySettings(SpeosSim.SimulationSettings simulationSettings)` +Clone | Create a copy of this object in the active context | `SpeosSim.Component3DTexture Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.Component3DTexture CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.Component3DTexture Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.Component3DTexture Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.Component3DTexture Create()` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +SupportGeometry | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureSupportGeometry SupportGeometry` +PatternFile | File attribute | `string PatternFile` +PatternFileFullPath | File attribute (absolute full path) | `string PatternFileFullPath` +PatternGlobalScale | Number attribute | `double PatternGlobalScale` +PatternGlobalScaleText | Number attribute (as text) | `string PatternGlobalScaleText` +OperationType | Enum attribute | `SpeosSim.Component3DTexture.EnumOperationType OperationType` +OperationTypeIndex | Enum attribute (as index) | `int OperationTypeIndex` +MappingType | Enum attribute | `SpeosSim.Component3DTexture.EnumMappingType MappingType` +MappingTypeIndex | Enum attribute (as index) | `int MappingTypeIndex` +MappingFile | File attribute | `string MappingFile` +MappingFileFullPath | File attribute (absolute full path) | `string MappingFileFullPath` +PatternStepX | Number attribute | `double PatternStepX` +PatternStepXText | Number attribute (as text) | `string PatternStepXText` +PatternStepY | Number attribute | `double PatternStepY` +PatternStepYText | Number attribute (as text) | `string PatternStepYText` +RadialDistance | Number attribute | `double RadialDistance` +RadialDistanceText | Number attribute (as text) | `string RadialDistanceText` +AreaRadius | Number attribute | `double AreaRadius` +AreaRadiusText | Number attribute (as text) | `string AreaRadiusText` +DistanceBetweenRings | Number attribute | `double DistanceBetweenRings` +DistanceBetweenRingsText | Number attribute (as text) | `string DistanceBetweenRingsText` +HexagonWidthX | Number attribute | `double HexagonWidthX` +HexagonWidthXText | Number attribute (as text) | `string HexagonWidthXText` +EdgeLengthX | Number attribute | `double EdgeLengthX` +EdgeLengthXText | Number attribute (as text) | `string EdgeLengthXText` +HexagonDistanceX | Number attribute | `double HexagonDistanceX` +HexagonDistanceXText | Number attribute (as text) | `string HexagonDistanceXText` +HexagonHeightY | Number attribute | `double HexagonHeightY` +HexagonHeightYText | Number attribute (as text) | `string HexagonHeightYText` +CentralPoint | boolean attribute | `bool CentralPoint` +RegularMapping | boolean attribute | `bool RegularMapping` +XPitchCurve | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureXPitchCurve XPitchCurve` +VarPitchXScale | Number attribute | `double VarPitchXScale` +VarPitchXScaleText | Number attribute (as text) | `string VarPitchXScaleText` +YPitchCurve | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureYPitchCurve YPitchCurve` +VarPitchYScale | Number attribute | `double VarPitchYScale` +VarPitchYScaleText | Number attribute (as text) | `string VarPitchYScaleText` +AreaLengthX | Number attribute | `double AreaLengthX` +AreaLengthXText | Number attribute (as text) | `string AreaLengthXText` +AreaLengthY | Number attribute | `double AreaLengthY` +AreaLengthYText | Number attribute (as text) | `string AreaLengthYText` +AngleX | Number attribute | `double AngleX` +AngleXText | Number attribute (as text) | `string AngleXText` +AngleY | Number attribute | `double AngleY` +AngleYText | Number attribute (as text) | `string AngleYText` +LimitingSurface | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureLimitingSurface LimitingSurface` +OffsetSurface | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureOffsetSurface OffsetSurface` +OffsetSurfaceScale | Number attribute | `double OffsetSurfaceScale` +OffsetSurfaceScaleText | Number attribute (as text) | `string OffsetSurfaceScaleText` +PatternDirectionType | Enum attribute | `SpeosSim.Component3DTexture.EnumPatternDirectionType PatternDirectionType` +PatternDirectionTypeIndex | Enum attribute (as index) | `int PatternDirectionTypeIndex` +XScaleSurface | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureXScaleSurface XScaleSurface` +PatternXScale | Number attribute | `double PatternXScale` +PatternXScaleText | Number attribute (as text) | `string PatternXScaleText` +YScaleSurface | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureYScaleSurface YScaleSurface` +PatternYScale | Number attribute | `double PatternYScale` +PatternYScaleText | Number attribute (as text) | `string PatternYScaleText` +ZScaleSurface | Link attribute | `SpeosSim.Component3DTexture.Component3DTextureZScaleSurface ZScaleSurface` +PatternZScale | Number attribute | `double PatternZScale` +PatternZScaleText | Number attribute (as text) | `string PatternZScaleText` +PreviewType | Enum attribute | `SpeosSim.Component3DTexture.EnumPreviewType PreviewType` +PreviewTypeIndex | Enum attribute (as index) | `int PreviewTypeIndex` +PreviewX | Number attribute | `double PreviewX` +PreviewXText | Number attribute (as text) | `string PreviewXText` +PreviewY | Number attribute | `double PreviewY` +PreviewYText | Number attribute (as text) | `string PreviewYText` +PreviewZ | Number attribute | `double PreviewZ` +PreviewZText | Number attribute (as text) | `string PreviewZText` +PreviewSizeX | Number attribute | `double PreviewSizeX` +PreviewSizeXText | Number attribute (as text) | `string PreviewSizeXText` +PreviewSizeY | Number attribute | `double PreviewSizeY` +PreviewSizeYText | Number attribute (as text) | `string PreviewSizeYText` +PreviewSizeZ | Number attribute | `double PreviewSizeZ` +PreviewSizeZText | Number attribute (as text) | `string PreviewSizeZText` +MaxNumberOfPatterns | Number attribute | `int MaxNumberOfPatterns` +MaxNumberOfPatternsText | Number attribute (as text) | `string MaxNumberOfPatternsText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### `Component3DTexture.Component3DTextureOriginPoint` + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### `Component3DTexture.Component3DTextureXDirection` + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureSupportGeometry + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureXPitchCurve + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureYPitchCurve + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureLimitingSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureOffsetSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureXScaleSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureYScaleSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Component3DTexture.Component3DTextureZScaleSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## ComponentExport + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ComponentExport Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.ComponentExport Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.ComponentExport Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.ComponentExport Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.ComponentExport CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetResultFilePath | Get the list of paths of all computation resulting files | `string GetResultFilePath()` +GetGeometrySettings | Get the geometry settings (meshing behavior) | `SpeosSim.SimulationSettings GetGeometrySettings()` +SetGeometrySettings | Set the geometry settings (meshing behavior) | `void SetGeometrySettings(SpeosSim.SimulationSettings simulationSettings)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.ComponentExport.ComponentExportOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.ComponentExport.ComponentExportXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.ComponentExport.ComponentExportYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +Sources | Links attribute | `SpeosSim.ComponentExport.ComponentExportSources Sources` +Geometries | Children attribute | `SpeosSim.ComponentExport.ComponentExportGeometries Geometries` +IsBlackBox | boolean attribute | `bool IsBlackBox` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ComponentExport.ComponentExportOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentExport.ComponentExportXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentExport.ComponentExportYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentExport.ComponentExportSources + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### ComponentExport.ComponentExportGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.FTGEnabledGeometry childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.FTGEnabledGeometry Item` + +## ComponentImport + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ComponentImport Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.ComponentImport Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.ComponentImport Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.ComponentImport Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.ComponentImport CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.ComponentImport.ComponentImportOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.ComponentImport.ComponentImportXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.ComponentImport.ComponentImportYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +TrajectoryFile | File attribute | `string TrajectoryFile` +TrajectoryFileFullPath | File attribute (absolute full path) | `string TrajectoryFileFullPath` +ImportFile | File attribute | `string ImportFile` +ImportFileFullPath | File attribute (absolute full path) | `string ImportFileFullPath` +LightBoxPreviewType | Enum attribute | `SpeosSim.ComponentImport.EnumLightBoxPreviewType LightBoxPreviewType` +LightBoxPreviewTypeIndex | Enum attribute (as index) | `int LightBoxPreviewTypeIndex` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ComponentImport.ComponentImportOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentImport.ComponentImportXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentImport.ComponentImportYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## ComponentOpticStudio + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ComponentOpticStudio Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.ComponentOpticStudio Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.ComponentOpticStudio Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.ComponentOpticStudio Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.ComponentOpticStudio CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetGeometrySettings | Get the geometry settings (meshing behavior) | `SpeosSim.SimulationSettings GetGeometrySettings()` +SetGeometrySettings | Set the geometry settings (meshing behavior) | `void SetGeometrySettings(SpeosSim.SimulationSettings simulationSettings)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +ComponentFile | File attribute | `Fou.Utils.ValueObjects.FilePath ComponentFile` +ComponentFileFullPath | File attribute (absolute full path) | `string ComponentFileFullPath` +SortedGeometricComponents | Children attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioSortedGeometricComponents SortedGeometricComponents` +Lenses | Children attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioLenses Lenses` +Surfaces | Children attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioSurfaces Surfaces` +Detectors | Links attribute | `SpeosSim.ComponentOpticStudio.ComponentOpticStudioDetectors Detectors` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ComponentOpticStudio.ComponentOpticStudioOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentOpticStudio.ComponentOpticStudioXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentOpticStudio.ComponentOpticStudioYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### ComponentOpticStudio.ComponentOpticStudioSortedGeometricComponents + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.GeometryOpticsStudio Item` +Item | Children attribute: Get child by index | `SpeosSim.GeometryOpticsStudio Item` + +### ComponentOpticStudio.ComponentOpticStudioLenses + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Lenses Item` + +### ComponentOpticStudio.ComponentOpticStudioSurfaces + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Surfaces Item` + +### ComponentOpticStudio.ComponentOpticStudioDetectors + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## ComponentSpeosPattern + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ComponentSpeosPattern Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.ComponentSpeosPattern Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.ComponentSpeosPattern Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.ComponentSpeosPattern Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.ComponentSpeosPattern CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +OptimizeRayFile | Call the 'Ray file optimization' command. Returns 'false' if this action is unavailable in the current state of the object. | `bool OptimizeRayFile()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OneLayerPerInstance | boolean attribute | `bool OneLayerPerInstance` +OneLayerPerSource | boolean attribute | `bool OneLayerPerSource` +FilePattern | File attribute | `Fou.Utils.ValueObjects.FilePath FilePattern` +FilePatternFullPath | File attribute (absolute full path) | `string FilePatternFullPath` +FluxType | Enum attribute | `SpeosSim.ComponentSpeosPattern.EnumFluxType FluxType` +FluxTypeIndex | Enum attribute (as index) | `int FluxTypeIndex` +FluxFromRayFile | boolean attribute | `bool FluxFromRayFile` +FluxValueLuminous | Number attribute | `double FluxValueLuminous` +FluxValueLuminousText | Number attribute (as text) | `string FluxValueLuminousText` +FluxValueRadiant | Number attribute | `double FluxValueRadiant` +FluxValueRadiantText | Number attribute (as text) | `string FluxValueRadiantText` +Origins | Links attribute | `SpeosSim.ComponentSpeosPattern.ComponentSpeosPatternOrigins Origins` +NumberOfRays | Number attribute | `uint NumberOfRays` +NumberOfRaysText | Number attribute (as text) | `string NumberOfRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +LightBoxPreviewType | Enum attribute | `SpeosSim.ComponentSpeosPattern.EnumLightBoxPreviewType LightBoxPreviewType` +LightBoxPreviewTypeIndex | Enum attribute (as index) | `int LightBoxPreviewTypeIndex` +SpectrumType | Enum attribute | `SpeosSim.ComponentSpeosPattern.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueWavelength | Number attribute | `double SpectrumValueWavelength` +SpectrumValueWavelengthText | Number attribute (as text) | `string SpectrumValueWavelengthText` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +SpectrumValueLibrary | File attribute | `Fou.Utils.ValueObjects.FilePath SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ComponentSpeosPattern.ComponentSpeosPatternOrigins + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## EyeboxConfiguration + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.EyeboxConfiguration Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +EBConfigName | string attribute | `string EBConfigName` +Offset | Number attribute | `double Offset` +OffsetText | Number attribute (as text) | `string OffsetText` +TiltAngle | Number attribute | `double TiltAngle` +TiltAngleText | Number attribute (as text) | `string TiltAngleText` + +## FTGEnabledGeometry + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.FTGEnabledGeometry Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +IsFTG | boolean attribute | `bool IsFTG` +FTGGeometry | Link attribute | `SpeosSim.FTGEnabledGeometry.FTGEnabledGeometryFTGGeometry FTGGeometry` + +### FTGEnabledGeometry.FTGEnabledGeometryFTGGeometry + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## GeometryOpticsStudio + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Body | Links attribute | `SpeosSim.GeometryOpticsStudio.GeometryOpticsStudioBody Body` +FrontFaces | Links attribute | `SpeosSim.GeometryOpticsStudio.GeometryOpticsStudioFrontFaces FrontFaces` +BackFaces | Links attribute | `SpeosSim.GeometryOpticsStudio.GeometryOpticsStudioBackFaces BackFaces` +EdgeFaces | Links attribute | `SpeosSim.GeometryOpticsStudio.GeometryOpticsStudioEdgeFaces EdgeFaces` +NewFaces | Links attribute | `SpeosSim.GeometryOpticsStudio.GeometryOpticsStudioNewFaces NewFaces` + +### GeometryOpticsStudio.GeometryOpticsStudioBody + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### GeometryOpticsStudio.GeometryOpticsStudioFrontFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### GeometryOpticsStudio.GeometryOpticsStudioBackFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### GeometryOpticsStudio.GeometryOpticsStudioEdgeFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### GeometryOpticsStudio.GeometryOpticsStudioNewFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## HoaEyeBox + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaEyeBox Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +EyeboxCenter | Link attribute | `SpeosSim.HoaEyeBox.HoaEyeBoxEyeboxCenter EyeboxCenter` +EyeboxOrientationType | Enum attribute | `SpeosSim.HoaEyeBox.EnumEyeboxOrientationType EyeboxOrientationType` +EyeboxOrientationTypeIndex | Enum attribute (as index) | `int EyeboxOrientationTypeIndex` +EyeboxSamplingMode | Enum attribute | `SpeosSim.HoaEyeBox.EnumEyeboxSamplingMode EyeboxSamplingMode` +EyeboxSamplingModeIndex | Enum attribute (as index) | `int EyeboxSamplingModeIndex` +OPTEyeBoxFile | File attribute | `string OPTEyeBoxFile` +OPTEyeBoxFileFullPath | File attribute (absolute full path) | `string OPTEyeBoxFileFullPath` +EBInterpupillaryDistance | Number attribute | `double EBInterpupillaryDistance` +EBInterpupillaryDistanceText | Number attribute (as text) | `string EBInterpupillaryDistanceText` +EBEyePupilDiameter | Number attribute | `double EBEyePupilDiameter` +EBEyePupilDiameterText | Number attribute (as text) | `string EBEyePupilDiameterText` +EBEyePupilSampling | Number attribute | `int EBEyePupilSampling` +EBEyePupilSamplingText | Number attribute (as text) | `string EBEyePupilSamplingText` +EBBinocularHorizontalSize | Number attribute | `double EBBinocularHorizontalSize` +EBBinocularHorizontalSizeText | Number attribute (as text) | `string EBBinocularHorizontalSizeText` +EBMonocularHorizontalSampling | Number attribute | `int EBMonocularHorizontalSampling` +EBMonocularHorizontalSamplingText | Number attribute (as text) | `string EBMonocularHorizontalSamplingText` +EBMonocularHorizontalSize | Number attribute | `double EBMonocularHorizontalSize` +EBMonocularHorizontalSizeText | Number attribute (as text) | `string EBMonocularHorizontalSizeText` +EBMonocularHorizontalResolution | Number attribute | `double EBMonocularHorizontalResolution` +EBMonocularHorizontalResolutionText | Number attribute (as text) | `string EBMonocularHorizontalResolutionText` +EBBinocularHorizontalSampling | Number attribute | `uint EBBinocularHorizontalSampling` +EBBinocularHorizontalSamplingText | Number attribute (as text) | `string EBBinocularHorizontalSamplingText` +EBNbSharedSamples | Number attribute | `uint EBNbSharedSamples` +EBNbSharedSamplesText | Number attribute (as text) | `string EBNbSharedSamplesText` +EBVerticalSize | Number attribute | `double EBVerticalSize` +EBVerticalSizeText | Number attribute (as text) | `string EBVerticalSizeText` +EBVerticalSampling | Number attribute | `int EBVerticalSampling` +EBVerticalSamplingText | Number attribute (as text) | `string EBVerticalSamplingText` +EBVerticalResolution | Number attribute | `double EBVerticalResolution` +EBVerticalResolutionText | Number attribute (as text) | `string EBVerticalResolutionText` +EBMultiEyebox | boolean attribute | `bool EBMultiEyebox` +EyeboxConfigPositionDirectionType | Enum attribute | `SpeosSim.HoaEyeBox.EnumEyeboxConfigPositionDirectionType EyeboxConfigPositionDirectionType` +EyeboxConfigPositionDirectionTypeIndex | Enum attribute (as index) | `int EyeboxConfigPositionDirectionTypeIndex` +EBConfigurations | Children attribute | `SpeosSim.HoaEyeBox.HoaEyeBoxEBConfigurations EBConfigurations` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### HoaEyeBox.HoaEyeBoxEyeboxCenter + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HoaEyeBox.HoaEyeBoxEBConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosSim.EyeboxConfiguration AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.EyeboxConfiguration Item` + +## HoaMirrors + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaMirrors Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +GetMultiEyeBoxMirrorPossibleValues | string list attribute: List possible values | `IEnumerable GetMultiEyeBoxMirrorPossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +MirrorFaces | Links attribute | `SpeosSim.HoaMirrors.HoaMirrorsMirrorFaces MirrorFaces` +MultiEyeBoxMirror | string list selection attribute | `string MultiEyeBoxMirror` +TiltRotationAxis | Link attribute | `SpeosSim.HoaMirrors.HoaMirrorsTiltRotationAxis TiltRotationAxis` +TiltRotationAxisReverse | boolean attribute | `bool TiltRotationAxisReverse` +EBMirrorConfigurations | Children attribute | `SpeosSim.HoaMirrors.HoaMirrorsEBMirrorConfigurations EBMirrorConfigurations` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### HoaMirrors.HoaMirrorsMirrorFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### HoaMirrors.HoaMirrorsTiltRotationAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HoaMirrors.HoaMirrorsEBMirrorConfigurations + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.EyeboxConfiguration Item` + +## HoaPGU + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaPGU Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PGUHorizontalSampling | Number attribute | `int PGUHorizontalSampling` +PGUHorizontalSamplingText | Number attribute (as text) | `string PGUHorizontalSamplingText` +PGUVerticalSampling | Number attribute | `int PGUVerticalSampling` +PGUVerticalSamplingText | Number attribute (as text) | `string PGUVerticalSamplingText` +PGUCharacteristicsType | Enum attribute | `SpeosSim.HoaPGU.EnumPGUCharacteristicsType PGUCharacteristicsType` +PGUCharacteristicsTypeIndex | Enum attribute (as index) | `int PGUCharacteristicsTypeIndex` +PGUHorizontalSize | Number attribute | `double PGUHorizontalSize` +PGUHorizontalSizeText | Number attribute (as text) | `string PGUHorizontalSizeText` +PGUHorizontalResolution | Number attribute | `int PGUHorizontalResolution` +PGUHorizontalResolutionText | Number attribute (as text) | `string PGUHorizontalResolutionText` +PGUVerticalSize | Number attribute | `double PGUVerticalSize` +PGUVerticalSizeText | Number attribute (as text) | `string PGUVerticalSizeText` +PGUVerticalResolution | Number attribute | `int PGUVerticalResolution` +PGUVerticalResolutionText | Number attribute (as text) | `string PGUVerticalResolutionText` +OriginPoint | Link attribute | `SpeosSim.HoaPGU.HoaPGUOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.HoaPGU.HoaPGUXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.HoaPGU.HoaPGUYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### HoaPGU.HoaPGUOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HoaPGU.HoaPGUXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HoaPGU.HoaPGUYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## HoaReport + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaReport Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +GetPluginTestsPossibleValues | string list attribute: List possible values | `IEnumerable GetPluginTestsPossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PluginTests | string list with multiple selection attribute | `IEnumerable PluginTests` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## HoaTargetImage + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaTargetImage Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +TIVirtualImageDistance | Number attribute | `double TIVirtualImageDistance` +TIVirtualImageDistanceText | Number attribute (as text) | `string TIVirtualImageDistanceText` +TILookOverAngle | Number attribute | `double TILookOverAngle` +TILookOverAngleText | Number attribute (as text) | `string TILookOverAngleText` +TILookDownAngle | Number attribute | `double TILookDownAngle` +TILookDownAngleText | Number attribute (as text) | `string TILookDownAngleText` +TargetImageModeType | Enum attribute | `SpeosSim.HoaTargetImage.EnumTargetImageModeType TargetImageModeType` +TargetImageModeTypeIndex | Enum attribute (as index) | `int TargetImageModeTypeIndex` +TIHorizontalSize | Number attribute | `double TIHorizontalSize` +TIHorizontalSizeText | Number attribute (as text) | `string TIHorizontalSizeText` +TIVerticalSize | Number attribute | `double TIVerticalSize` +TIVerticalSizeText | Number attribute (as text) | `string TIVerticalSizeText` +TIHorizontalFOV | Number attribute | `double TIHorizontalFOV` +TIHorizontalFOVText | Number attribute (as text) | `string TIHorizontalFOVText` +TIVerticalFOV | Number attribute | `double TIVerticalFOV` +TIVerticalFOVText | Number attribute (as text) | `string TIVerticalFOVText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## HoaWarping + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaWarping Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +GetAlgorithmPossibleValues | string list attribute: List possible values | `IEnumerable GetAlgorithmPossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +WarpingMode | Enum attribute | `SpeosSim.HoaWarping.EnumWarpingMode WarpingMode` +WarpingModeIndex | Enum attribute (as index) | `int WarpingModeIndex` +HorizontalSampling | Number attribute | `int HorizontalSampling` +HorizontalSamplingText | Number attribute (as text) | `string HorizontalSamplingText` +VerticalSampling | Number attribute | `int VerticalSampling` +VerticalSamplingText | Number attribute (as text) | `string VerticalSamplingText` +OPTWarpingFile | File attribute | `string OPTWarpingFile` +OPTWarpingFileFullPath | File attribute (absolute full path) | `string OPTWarpingFileFullPath` +Algorithm | string list selection attribute | `string Algorithm` +AlgorithmFile | File attribute | `string AlgorithmFile` +AlgorithmFileFullPath | File attribute (absolute full path) | `string AlgorithmFileFullPath` +TiltMode | Enum attribute | `SpeosSim.HoaWarping.EnumTiltMode TiltMode` +TiltModeIndex | Enum attribute (as index) | `int TiltModeIndex` +TiltShorterDriver | Number attribute | `double TiltShorterDriver` +TiltShorterDriverText | Number attribute (as text) | `string TiltShorterDriverText` +TiltTallerDriver | Number attribute | `double TiltTallerDriver` +TiltTallerDriverText | Number attribute (as text) | `string TiltTallerDriverText` +OffsetShorterDriver | Number attribute | `double OffsetShorterDriver` +OffsetShorterDriverText | Number attribute (as text) | `string OffsetShorterDriverText` +OffsetTallerDriver | Number attribute | `double OffsetTallerDriver` +OffsetTallerDriverText | Number attribute (as text) | `string OffsetTallerDriverText` +TiltSampling | Number attribute | `int TiltSampling` +TiltSamplingText | Number attribute (as text) | `string TiltSamplingText` +TiltResolution | Number attribute | `double TiltResolution` +TiltResolutionText | Number attribute (as text) | `string TiltResolutionText` +OffsetResolution | Number attribute | `double OffsetResolution` +OffsetResolutionText | Number attribute (as text) | `string OffsetResolutionText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## HoaWindshield + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.HoaWindshield Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +WindshieldInnerSurface | Link attribute | `SpeosSim.HoaWindshield.HoaWindshieldWindshieldInnerSurface WindshieldInnerSurface` +WindshieldOuterSurface | Link attribute | `SpeosSim.HoaWindshield.HoaWindshieldWindshieldOuterSurface WindshieldOuterSurface` +WindshieldRefractiveIndex | Number attribute | `double WindshieldRefractiveIndex` +WindshieldRefractiveIndexText | Number attribute (as text) | `string WindshieldRefractiveIndexText` +CoverLensOuterSurface | Link attribute | `SpeosSim.HoaWindshield.HoaWindshieldCoverLensOuterSurface CoverLensOuterSurface` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### HoaWindshield.HoaWindshieldWindshieldInnerSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HoaWindshield.HoaWindshieldWindshieldOuterSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### HoaWindshield.HoaWindshieldCoverLensOuterSurface + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## ImportedFeature + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ImportedFeature Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +ImportedObjectType | Enum attribute | `SpeosSim.ImportedFeature.EnumImportedObjectType ImportedObjectType` +ImportedObjectTypeIndex | Enum attribute (as index) | `int ImportedObjectTypeIndex` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## Lenses + +### Method + +Name | Description | Syntax +--- | --- | --- +MoveToFront | | `void MoveToFront(SpaceClaim.Api.V251.IDocObject selectedFace)` +MoveToBack | | `void MoveToBack(SpaceClaim.Api.V251.IDocObject selectedFace)` +MoveToEdge | | `void MoveToEdge(SpaceClaim.Api.V251.IDocObject selectedFace)` +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +FrontFaceParameters | Children attribute | `SpeosSim.Surfaces FrontFaceParameters` +BackFaceParameters | Children attribute | `SpeosSim.Surfaces BackFaceParameters` +Thickness | Number attribute | `double Thickness` +ThicknessText | Number attribute (as text) | `string ThicknessText` +FrontFaceSOP | Children attribute | `SpeosSim.Sop FrontFaceSOP` +BackFaceSOP | Children attribute | `SpeosSim.Sop BackFaceSOP` +EdgeFaceSOP | Children attribute | `SpeosSim.Sop EdgeFaceSOP` +VOP | Children attribute | `SpeosSim.Vop VOP` +Body | Links attribute | `SpeosSim.Lenses.LensesBody Body` +FrontFaces | Links attribute | `SpeosSim.Lenses.LensesFrontFaces FrontFaces` +BackFaces | Links attribute | `SpeosSim.Lenses.LensesBackFaces BackFaces` +EdgeFaces | Links attribute | `SpeosSim.Lenses.LensesEdgeFaces EdgeFaces` +NewFaces | Links attribute | `SpeosSim.Lenses.LensesNewFaces NewFaces` + +### Lenses.LensesBody + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Lenses.LensesFrontFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Lenses.LensesBackFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Lenses.LensesEdgeFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Lenses.LensesNewFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## LocalMeshing + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.LocalMeshing Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.LocalMeshing Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.LocalMeshing Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.LocalMeshing Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.LocalMeshing CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +MeshingSagMode | Enum attribute | `SpeosSim.LocalMeshing.EnumMeshingSagMode MeshingSagMode` +MeshingSagModeIndex | Enum attribute (as index) | `int MeshingSagModeIndex` +MeshingSagValue | Number attribute | `double MeshingSagValue` +MeshingSagValueText | Number attribute (as text) | `string MeshingSagValueText` +MeshingSagValueProportionalToBody | Number attribute | `double MeshingSagValueProportionalToBody` +MeshingSagValueProportionalToBodyText | Number attribute (as text) | `string MeshingSagValueProportionalToBodyText` +MeshingSagLengthValue | Number attribute | `double MeshingSagLengthValue` +MeshingSagLengthValueText | Number attribute (as text) | `string MeshingSagLengthValueText` +MeshingStepMode | Enum attribute | `SpeosSim.LocalMeshing.EnumMeshingStepMode MeshingStepMode` +MeshingStepModeIndex | Enum attribute (as index) | `int MeshingStepModeIndex` +MeshingStepValue | Number attribute | `double MeshingStepValue` +MeshingStepValueText | Number attribute (as text) | `string MeshingStepValueText` +MeshingStepValueProportionalToBody | Number attribute | `double MeshingStepValueProportionalToBody` +MeshingStepValueProportionalToBodyText | Number attribute (as text) | `string MeshingStepValueProportionalToBodyText` +MeshingStepLengthValue | Number attribute | `double MeshingStepLengthValue` +MeshingStepLengthValueText | Number attribute (as text) | `string MeshingStepLengthValueText` +MeshingAngle | Number attribute | `double MeshingAngle` +MeshingAngleText | Number attribute (as text) | `string MeshingAngleText` +Geometries | Links attribute | `SpeosSim.LocalMeshing.LocalMeshingGeometries Geometries` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### LocalMeshing.LocalMeshingGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## LXPEnabledSensor + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.LXPEnabledSensor Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +IsLXP | boolean attribute | `bool IsLXP` +LXPSensor | Link attribute | `SpeosSim.LXPEnabledSensor.LXPEnabledSensorLXPSensor LXPSensor` + +### LXPEnabledSensor.LXPEnabledSensorLXPSensor + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## Material + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.Material Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.Material Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.Material Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.Material Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.Material CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Description | string attribute | `string Description` +VisualizationColorText | Color attribute (as text like "R,G,B") | `string VisualizationColorText` +OpticalPropertiesType | Enum attribute | `SpeosSim.Material.EnumOpticalPropertiesType OpticalPropertiesType` +OpticalPropertiesTypeIndex | Enum attribute (as index) | `int OpticalPropertiesTypeIndex` +HasMultipleSOP | boolean attribute | `bool HasMultipleSOP` +VolumeGeometries | Links attribute | `SpeosSim.Material.MaterialVolumeGeometries VolumeGeometries` +OrientedFaces | Children attribute | `SpeosSim.Material.MaterialOrientedFaces OrientedFaces` +ListSOP | Children attribute | `SpeosSim.Material.MaterialListSOP ListSOP` +SOPType | Enum attribute | `SpeosSim.Material.EnumSOPType SOPType` +SOPTypeIndex | Enum attribute (as index) | `int SOPTypeIndex` +SOPReflectance | Number attribute | `double SOPReflectance` +SOPReflectanceText | Number attribute (as text) | `string SOPReflectanceText` +SOPLibrary | File attribute | `string SOPLibrary` +SOPLibraryFullPath | File attribute (absolute full path) | `string SOPLibraryFullPath` +SopPluginPath | File attribute | `string SopPluginPath` +SopPluginPathFullPath | File attribute (absolute full path) | `string SopPluginPathFullPath` +SopPluginConfigurationPath | File attribute | `string SopPluginConfigurationPath` +SopPluginConfigurationPathFullPath | File attribute (absolute full path) | `string SopPluginConfigurationPathFullPath` +PreviewedLayer | Enum attribute | `SpeosSim.Material.EnumPreviewedLayer PreviewedLayer` +PreviewedLayerIndex | Enum attribute (as index) | `int PreviewedLayerIndex` +VOPType | Enum attribute | `SpeosSim.Material.EnumVOPType VOPType` +VOPTypeIndex | Enum attribute (as index) | `int VOPTypeIndex` +VOPIndex | Number attribute | `double VOPIndex` +VOPIndexText | Number attribute (as text) | `string VOPIndexText` +VOPAbsorption | Number attribute | `double VOPAbsorption` +VOPAbsorptionText | Number attribute (as text) | `string VOPAbsorptionText` +VOPIsConstringence | boolean attribute | `bool VOPIsConstringence` +VOPConstringence | Number attribute | `double VOPConstringence` +VOPConstringenceText | Number attribute (as text) | `string VOPConstringenceText` +VOPLibrary | File attribute | `string VOPLibrary` +VOPLibraryFullPath | File attribute (absolute full path) | `string VOPLibraryFullPath` +GradedFile | File attribute | `string GradedFile` +GradedFileFullPath | File attribute (absolute full path) | `string GradedFileFullPath` +OriginPoint | Link attribute | `SpeosSim.Material.MaterialOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.Material.MaterialXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.Material.MaterialYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### Material.MaterialVolumeGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Material.MaterialOrientedFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.OrientedFace childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.OrientedFace Item` + +### Material.MaterialListSOP + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +AddNew | Children attribute: Create a new child object | `SpeosSim.SurfaceLayer AddNew(int insertIndex)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.SurfaceLayer Item` +Item | Children attribute: Get child by index | `SpeosSim.SurfaceLayer Item` + +### Material.MaterialOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Material.MaterialXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Material.MaterialYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## Node + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.Node Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## OrientedFace + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.OrientedFace Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +ReverseDirection | boolean attribute | `bool ReverseDirection` +Face | Link attribute | `SpeosSim.OrientedFace.OrientedFaceFace Face` + +### OrientedFace.OrientedFaceFace + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## ResultLXP + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ResultLXP Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +ExportRaysAsGeometry | Export the Light Expert rays as geometry | `void ExportRaysAsGeometry()` +UpdateResults | Update the .xmp files | `void UpdateResults()` +OpenLpf | Load the file | `void OpenLpf()` +CloseLpf | Unload the file | `void CloseLpf()` +CreateAreaRectangle | Creates a rectangular measure area | `void CreateAreaRectangle(int viewerId, double xCenter, double yCenter, double width, double height)` +CreateAreaEllipse | Creates an elliptical measure area | `void CreateAreaEllipse(int viewerId, double xCenter, double yCenter, double xRadius, double yRadius)` +CreateAreaPolygon | Creates a polygon measure area | `void CreateAreaPolygon(int viewerId, System.Double[] xPoints, System.Double[] yPoints)` +GetMeasureValue | Gets the measure value from a defined type. Refer to [GetMeasureValue Enum List](resultlxp_getmeasurevalue_list_enum.md) for the possible values to be used.| `double GetMeasureValue(int viewerId, int measureId)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +RequiredFaces | Links attribute | `SpeosSim.ResultLXP.ResultLXPRequiredFaces RequiredFaces` +RejectedFaces | Links attribute | `SpeosSim.ResultLXP.ResultLXPRejectedFaces RejectedFaces` +FaceFiltering | Enum attribute | `SpeosSim.ResultLXP.EnumFaceFiltering FaceFiltering` +FaceFilteringIndex | Enum attribute (as index) | `int FaceFilteringIndex` +RaysPassingBy | Enum attribute | `SpeosSim.ResultLXP.EnumRaysPassingBy RaysPassingBy` +RaysPassingByIndex | Enum attribute (as index) | `int RaysPassingByIndex` +FilteredRaysOnly | boolean attribute | `bool FilteredRaysOnly` +RayNumber | Number attribute | `uint RayNumber` +RayNumberText | Number attribute (as text) | `string RayNumberText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +RotationViewDistance | Number attribute | `double RotationViewDistance` +RotationViewDistanceText | Number attribute (as text) | `string RotationViewDistanceText` +RaysErrorType | Enum attribute | `SpeosSim.ResultLXP.EnumRaysErrorType RaysErrorType` +RaysErrorTypeIndex | Enum attribute (as index) | `int RaysErrorTypeIndex` +RaysDrawType | Enum attribute | `SpeosSim.ResultLXP.EnumRaysDrawType RaysDrawType` +RaysDrawTypeIndex | Enum attribute (as index) | `int RaysDrawTypeIndex` +DrawThickness | Number attribute | `int DrawThickness` +DrawThicknessText | Number attribute (as text) | `string DrawThicknessText` +FullPath | Get the result file full path | `string FullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### ResultLXP.ResultLXPRequiredFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### ResultLXP.ResultLXPRejectedFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## ResultProjectedGrid + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.ResultProjectedGrid Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +ExportProjectedGridAsGeometry | Export the projected grid as geometry | `void ExportProjectedGridAsGeometry()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +MinDistanceTolerance | Number attribute | `double MinDistanceTolerance` +MinDistanceToleranceText | Number attribute (as text) | `string MinDistanceToleranceText` +MaxIncidence | Number attribute | `double MaxIncidence` +MaxIncidenceText | Number attribute (as text) | `string MaxIncidenceText` +MaxDistanceFromCamera | Number attribute | `double MaxDistanceFromCamera` +MaxDistanceFromCameraText | Number attribute (as text) | `string MaxDistanceFromCameraText` +AuthorizeConnectionBetweenBodies | boolean attribute | `bool AuthorizeConnectionBetweenBodies` +PrimaryStep | Number attribute | `int PrimaryStep` +PrimaryStepText | Number attribute (as text) | `string PrimaryStepText` +SecondaryStep | Number attribute | `int SecondaryStep` +SecondaryStepText | Number attribute (as text) | `string SecondaryStepText` +DisplayGraduationText | boolean attribute | `bool DisplayGraduationText` +DisplayFirstHighLightedLines | boolean attribute | `bool DisplayFirstHighLightedLines` +XDisplayFirst | Number attribute | `int XDisplayFirst` +XDisplayFirstText | Number attribute (as text) | `string XDisplayFirstText` +YDisplayFirst | Number attribute | `int YDisplayFirst` +YDisplayFirstText | Number attribute (as text) | `string YDisplayFirstText` +DisplaySecondHighLightedLines | boolean attribute | `bool DisplaySecondHighLightedLines` +XDisplaySecond | Number attribute | `int XDisplaySecond` +XDisplaySecondText | Number attribute (as text) | `string XDisplaySecondText` +YDisplaySecond | Number attribute | `int YDisplaySecond` +YDisplaySecondText | Number attribute (as text) | `string YDisplaySecondText` +CloseBoundaries | boolean attribute | `bool CloseBoundaries` +FullPath | Get the result file full path | `string FullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## Sensor3DED + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.Sensor3DED Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.Sensor3DED Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.Sensor3DED Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.Sensor3DED Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.Sensor3DED CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +SizeX | Number attribute | `double SizeX` +SizeXText | Number attribute (as text) | `string SizeXText` +SamplingX | Number attribute | `uint SamplingX` +SamplingXText | Number attribute (as text) | `string SamplingXText` +SizeY | Number attribute | `double SizeY` +SizeYText | Number attribute (as text) | `string SizeYText` +SamplingY | Number attribute | `uint SamplingY` +SamplingYText | Number attribute (as text) | `string SamplingYText` +SizeZ | Number attribute | `double SizeZ` +SizeZText | Number attribute (as text) | `string SizeZText` +SamplingZ | Number attribute | `uint SamplingZ` +SamplingZText | Number attribute (as text) | `string SamplingZText` +SensorType | Enum attribute | `SpeosSim.Sensor3DED.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +IntegrationMode | Enum attribute | `SpeosSim.Sensor3DED.EnumIntegrationMode IntegrationMode` +IntegrationModeIndex | Enum attribute (as index) | `int IntegrationModeIndex` +LayerType | Enum attribute | `SpeosSim.Sensor3DED.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +FaceFiltering | Links attribute | `SpeosSim.Sensor3DED.Sensor3DEDFaceFiltering FaceFiltering` +SCAFilteringMode | Enum attribute | `SpeosSim.Sensor3DED.EnumSCAFilteringMode SCAFilteringMode` +SCAFilteringModeIndex | Enum attribute (as index) | `int SCAFilteringModeIndex` +OriginPoint | Link attribute | `SpeosSim.Sensor3DED.Sensor3DEDOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.Sensor3DED.Sensor3DEDXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.Sensor3DED.Sensor3DEDYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### Sensor3DED.Sensor3DEDFaceFiltering + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Sensor3DED.Sensor3DEDOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Sensor3DED.Sensor3DEDXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### Sensor3DED.Sensor3DEDYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## Sensor3DIrradiance + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.Sensor3DIrradiance Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.Sensor3DIrradiance Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.Sensor3DIrradiance Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.Sensor3DIrradiance Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.Sensor3DIrradiance CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +SensorType | Enum attribute | `SpeosSim.Sensor3DIrradiance.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +IlluminanceType | Enum attribute | `SpeosSim.Sensor3DIrradiance.EnumIlluminanceType IlluminanceType` +IlluminanceTypeIndex | Enum attribute (as index) | `int IlluminanceTypeIndex` +RayFileType | Enum attribute | `SpeosSim.Sensor3DIrradiance.EnumRayFileType RayFileType` +RayFileTypeIndex | Enum attribute (as index) | `int RayFileTypeIndex` +LayerType | Enum attribute | `SpeosSim.Sensor3DIrradiance.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +Reflection | boolean attribute | `bool Reflection` +Transmission | boolean attribute | `bool Transmission` +Absorption | boolean attribute | `bool Absorption` +Geometries | Links attribute | `SpeosSim.Sensor3DIrradiance.Sensor3DIrradianceGeometries Geometries` +XM3TemplateFile | File attribute | `string XM3TemplateFile` +XM3TemplateFileFullPath | File attribute (absolute full path) | `string XM3TemplateFileFullPath` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### Sensor3DIrradiance.Sensor3DIrradianceGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SensorCamera + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorCamera Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorCamera Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorCamera Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorCamera Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorCamera CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +SensorMode | Enum attribute | `SpeosSim.SensorCamera.EnumSensorMode SensorMode` +SensorModeIndex | Enum attribute (as index) | `int SensorModeIndex` +LayerType | Enum attribute | `SpeosSim.SensorCamera.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +OriginPoint | Link attribute | `SpeosSim.SensorCamera.SensorCameraOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SensorCamera.SensorCameraXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SensorCamera.SensorCameraYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +TrajectoryFile | File attribute | `string TrajectoryFile` +TrajectoryFileFullPath | File attribute (absolute full path) | `string TrajectoryFileFullPath` +AcquisitionIntegration | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration AcquisitionIntegration` +AcquisitionIntegrationText | Number attribute (as text) | `string AcquisitionIntegrationText` +AcquisitionLagTime | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration AcquisitionLagTime` +AcquisitionLagTimeText | Number attribute (as text) | `string AcquisitionLagTimeText` +WStart | Number attribute | `double WStart` +WStartText | Number attribute (as text) | `string WStartText` +WEnd | Number attribute | `double WEnd` +WEndText | Number attribute (as text) | `string WEndText` +WSamples | Number attribute | `uint WSamples` +WSamplesText | Number attribute (as text) | `string WSamplesText` +WResolution | Number attribute | `double WResolution` +WResolutionText | Number attribute (as text) | `string WResolutionText` +FocalLength | Number attribute | `double FocalLength` +FocalLengthText | Number attribute (as text) | `string FocalLengthText` +ImagerDistance | Number attribute | `double ImagerDistance` +ImagerDistanceText | Number attribute (as text) | `string ImagerDistanceText` +FNumber | Number attribute | `double FNumber` +FNumberText | Number attribute (as text) | `string FNumberText` +HorzFov | Number attribute | `double HorzFov` +HorzFovText | Number attribute (as text) | `string HorzFovText` +VertFov | Number attribute | `double VertFov` +VertFovText | Number attribute (as text) | `string VertFovText` +HorzPixel | Number attribute | `uint HorzPixel` +HorzPixelText | Number attribute (as text) | `string HorzPixelText` +VertPixel | Number attribute | `uint VertPixel` +VertPixelText | Number attribute (as text) | `string VertPixelText` +Width | Number attribute | `double Width` +WidthText | Number attribute (as text) | `string WidthText` +Height | Number attribute | `double Height` +HeightText | Number attribute (as text) | `string HeightText` +ColorMode | Enum attribute | `SpeosSim.SensorCamera.EnumColorMode ColorMode` +ColorModeIndex | Enum attribute (as index) | `int ColorModeIndex` +GammaCorrection | Number attribute | `double GammaCorrection` +GammaCorrectionText | Number attribute (as text) | `string GammaCorrectionText` +BalanceMode | Enum attribute | `SpeosSim.SensorCamera.EnumBalanceMode BalanceMode` +BalanceModeIndex | Enum attribute (as index) | `int BalanceModeIndex` +RedGain | Number attribute | `double RedGain` +RedGainText | Number attribute (as text) | `string RedGainText` +GreenGain | Number attribute | `double GreenGain` +GreenGainText | Number attribute (as text) | `string GreenGainText` +BlueGain | Number attribute | `double BlueGain` +BlueGainText | Number attribute (as text) | `string BlueGainText` +PNGBits | Enum attribute | `SpeosSim.SensorCamera.EnumPNGBits PNGBits` +PNGBitsIndex | Enum attribute (as index) | `int PNGBitsIndexv +TransmittanceFile | File attribute | `string TransmittanceFile` +TransmittanceFileFullPath | File attribute (absolute full path) | `string TransmittanceFileFullPath` +DistorsionFile | File attribute | `string DistorsionFile` +DistorsionFileFullPath | File attribute (absolute full path) | `string DistorsionFileFullPath` +SpectrumFile | File attribute | `string SpectrumFile` +SpectrumFileFullPath | File attribute (absolute full path) | `string SpectrumFileFullPath` +RedSpectrumFile | File attribute | `string RedSpectrumFile` +RedSpectrumFileFullPath | File attribute (absolute full path) | `string RedSpectrumFileFullPath` +GreenSpectrumFile | File attribute | `string GreenSpectrumFile` +GreenSpectrumFileFullPath | File attribute (absolute full path) | `string GreenSpectrumFileFullPath` +BlueSpectrumFile | File attribute | `string BlueSpectrumFile` +BlueSpectrumFileFullPath | File attribute (absolute full path) | `string BlueSpectrumFileFullPath` +RedDisplaySpectrumFile | File attribute | `string RedDisplaySpectrumFile` +RedDisplaySpectrumFileFullPath | File attribute (absolute full path) | `string RedDisplaySpectrumFileFullPath` +GreenDisplaySpectrumFile | File attribute | `string GreenDisplaySpectrumFile` +GreenDisplaySpectrumFileFullPath | File attribute (absolute full path) | `string GreenDisplaySpectrumFileFullPath` +BlueDisplaySpectrumFile | File attribute | `string BlueDisplaySpectrumFile` +BlueDisplaySpectrumFileFullPath | File attribute (absolute full path) | `string BlueDisplaySpectrumFileFullPath` +DisplayImageField | boolean attribute | `bool DisplayImageField` +DisplayObjectField | boolean attribute | `bool DisplayObjectField` +DisplayPupil | boolean attribute | `bool DisplayPupil` +ObjectFieldVisuRadius | Number attribute | `double ObjectFieldVisuRadius` +ObjectFieldVisuRadiusText | Number attribute (as text) | `string ObjectFieldVisuRadiusText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorCamera.SensorCameraOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorCamera.SensorCameraXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### `SensorCamera.SensorCameraYDirection` + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorEye + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorEye Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorEye Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorEye Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorEye Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorEye CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.SensorEye.SensorEyeOriginPoint OriginPoint` +TargetPoint | Link attribute | `SpeosSim.SensorEye.SensorEyeTargetPoint TargetPoint` +TopDirection | Link attribute | `SpeosSim.SensorEye.SensorEyeTopDirection TopDirection` +TopDirectionReverse | boolean attribute | `bool TopDirectionReverse` +SensorType | Enum attribute | `SpeosSim.SensorEye.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +LayerType | Enum attribute | `SpeosSim.SensorEye.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +DefinitionFrom | Enum attribute | `SpeosSim.SensorEye.EnumDefinitionFrom DefinitionFrom` +DefinitionFromIndex | Enum attribute (as index) | `int DefinitionFromIndex` +XMPTemplateFile | File attribute | `string XMPTemplateFile` +XMPTemplateFileFullPath | File attribute (absolute full path) | `string XMPTemplateFileFullPath` +DimensionFromFile | boolean attribute | `bool DimensionFromFile` +DisplayPropertiesFromFile | boolean attribute | `bool DisplayPropertiesFromFile` +XIsMirrored | boolean attribute | `bool XIsMirrored` +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +XNbSamples | Number attribute | `uint XNbSamples` +XNbSamplesText | Number attribute (as text) | `string XNbSamplesText` +XResolution | Number attribute | `double XResolution` +XResolutionText | Number attribute (as text) | `string XResolutionText` +YIsMirrored | boolean attribute | `bool YIsMirrored` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +YNbSamples | Number attribute | `uint YNbSamples` +YNbSamplesText | Number attribute (as text) | `string YNbSamplesText` +YResolution | Number attribute | `double YResolution` +YResolutionText | Number attribute (as text) | `string YResolutionText` +PupilDiameter | Number attribute | `double PupilDiameter` +PupilDiameterText | Number attribute (as text) | `string PupilDiameterText` +ShowGrid | boolean attribute | `bool ShowGrid` +OriginX | Number attribute | `double OriginX` +OriginXText | Number attribute (as text) | `string OriginXText` +OriginY | Number attribute | `double OriginY` +OriginYText | Number attribute (as text) | `string OriginYText` +StepX | Number attribute | `double StepX` +StepXText | Number attribute (as text) | `string StepXText` +StepY | Number attribute | `double StepY` +StepYText | Number attribute (as text) | `string StepYText` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthSampling | Number attribute | `uint WavelengthSampling` +WavelengthSamplingText | Number attribute (as text) | `string WavelengthSamplingText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorEye.SensorEyeOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorEye.SensorEyeTargetPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorEye.SensorEyeTopDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorImmersive + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorImmersive Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorImmersive Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorImmersive Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorImmersive Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorImmersive CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Sampling | Number attribute | `uint Sampling` +SamplingText | Number attribute (as text) | `string SamplingText` +CentralResolution | Number attribute | `double CentralResolution` +CentralResolutionText | Number attribute (as text) | `string CentralResolutionText` +Stereo | boolean attribute | `bool Stereo` +InterocularDistance | Number attribute | `double InterocularDistance` +InterocularDistanceText | Number attribute (as text) | `string InterocularDistanceText` +LayerType | Enum attribute | `SpeosSim.SensorImmersive.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +IntegrationAngle | Number attribute | `double IntegrationAngle` +IntegrationAngleText | Number attribute (as text) | `string IntegrationAngleText` +VisuSize | Number attribute | `double VisuSize` +VisuSizeText | Number attribute (as text) | `string VisuSizeText` +Front | boolean attribute | `bool Front` +Back | boolean attribute | `bool Back` +Top | boolean attribute | `bool Top` +Bottom | boolean attribute | `bool Bottom` +Left | boolean attribute | `bool Left` +Right | boolean attribute | `bool Right` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +OriginPoint | Link attribute | `SpeosSim.SensorImmersive.SensorImmersiveOriginPoint OriginPoint` +FrontDirection | Link attribute | `SpeosSim.SensorImmersive.SensorImmersiveFrontDirection FrontDirection` +FrontDirectionReverse | boolean attribute | `bool FrontDirectionReverse` +TopDirection | Link attribute | `SpeosSim.SensorImmersive.SensorImmersiveTopDirection TopDirection` +TopDirectionReverse | boolean attribute | `bool TopDirectionReverse` +AutoFramingFaceSelection | Enum attribute | `SpeosSim.SensorImmersive.EnumAutoFramingFaceSelection AutoFramingFaceSelection` +AutoFramingFaceSelectionIndex | Enum attribute (as index) | `int AutoFramingFaceSelectionIndex` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorImmersive.SensorImmersiveOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorImmersive.SensorImmersiveFrontDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorImmersive.SensorImmersiveTopDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorIntensity + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorIntensity Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorIntensity Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorIntensity Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorIntensity Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorIntensity CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.SensorIntensity.SensorIntensityOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SensorIntensity.SensorIntensityXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SensorIntensity.SensorIntensityYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +SensorType | Enum attribute | `SpeosSim.SensorIntensity.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +FormatType | Enum attribute | `SpeosSim.SensorIntensity.EnumFormatType FormatType` +FormatTypeIndex | Enum attribute (as index) | `int FormatTypeIndex` +IntensityType | Enum attribute | `SpeosSim.SensorIntensity.EnumIntensityType IntensityType` +IntensityTypeIndex | Enum attribute (as index) | `int IntensityTypeIndex` +LayerType | Enum attribute | `SpeosSim.SensorIntensity.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +FaceFiltering | Links attribute | `SpeosSim.SensorIntensity.SensorIntensityFaceFiltering FaceFiltering` +SCAFilteringMode | Enum attribute | `SpeosSim.SensorIntensity.EnumSCAFilteringMode SCAFilteringMode` +SCAFilteringModeIndex | Enum attribute (as index) | `int SCAFilteringModeIndex` +MaximumNbOfSequence | Number attribute | `uint MaximumNbOfSequence` +MaximumNbOfSequenceText | Number attribute (as text) | `string MaximumNbOfSequenceText` +DefineSequencePer | Enum attribute | `SpeosSim.SensorIntensity.EnumDefineSequencePer DefineSequencePer` +DefineSequencePerIndex | Enum attribute (as index) | `int DefineSequencePerIndex` +AdaptativeSampling | File attribute | `string AdaptativeSampling` +AdaptativeSamplingFullPath | File attribute (absolute full path) | `string AdaptativeSamplingFullPath` +ThetaStart | Number attribute | `double ThetaStart` +ThetaStartText | Number attribute (as text) | `string ThetaStartText` +ThetaSampling | Number attribute | `uint ThetaSampling` +ThetaSamplingText | Number attribute (as text) | `string ThetaSamplingText` +ThetaResolution | Number attribute | `double ThetaResolution` +ThetaResolutionText | Number attribute (as text) | `string ThetaResolutionText` +XIsMirrored | boolean attribute | `bool XIsMirrored` +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +XNbSamples | Number attribute | `uint XNbSamples` +XNbSamplesText | Number attribute (as text) | `string XNbSamplesText` +XResolution | Number attribute | `double XResolution` +XResolutionText | Number attribute (as text) | `string XResolutionText` +YIsMirrored | boolean attribute | `bool YIsMirrored` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +YNbSamples | Number attribute | `uint YNbSamples` +YNbSamplesText | Number attribute (as text) | `string YNbSamplesText` +YResolution | Number attribute | `double YResolution` +YResolutionText | Number attribute (as text) | `string YResolutionText` +NearField | boolean attribute | `bool NearField` +CellDistance | Number attribute | `double CellDistance` +CellDistanceText | Number attribute (as text) | `string CellDistanceText` +CellDiameter | Number attribute | `double CellDiameter` +CellDiameterText | Number attribute (as text) | `string CellDiameterText` +VisuRadius | Number attribute | `double VisuRadius` +VisuRadiusText | Number attribute (as text) | `string VisuRadiusText` +IntegrationAngle | Number attribute | `double IntegrationAngle` +IntegrationAngleText | Number attribute (as text) | `string IntegrationAngleText` +ResultViewingDirection | Enum attribute | `SpeosSim.SensorIntensity.EnumResultViewingDirection ResultViewingDirection` +ResultViewingDirectionIndex | Enum attribute (as index) | `int ResultViewingDirectionIndex` +ShowGrid | boolean attribute | `bool ShowGrid` +OriginX | Number attribute | `double OriginX` +OriginXText | Number attribute (as text) | `string OriginXText` +OriginY | Number attribute | `double OriginY` +OriginYText | Number attribute (as text) | `string OriginYText` +StepX | Number attribute | `double StepX` +StepXText | Number attribute (as text) | `string StepXText` +StepY | Number attribute | `double StepY` +StepYText | Number attribute (as text) | `string StepYText` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +XMPTemplateFile | File attribute | `string XMPTemplateFile` +XMPTemplateFileFullPath | File attribute (absolute full path) | `string XMPTemplateFileFullPath` +DimensionFromFile | boolean attribute | `bool DimensionFromFile` +DisplayPropertiesFromFile | boolean attribute | `bool DisplayPropertiesFromFile` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorIntensity.SensorIntensityOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIntensity.SensorIntensityXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIntensity.SensorIntensityYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIntensity.SensorIntensityFaceFiltering + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SensorIrradiance + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorIrradiance Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorIrradiance Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorIrradiance Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorIrradiance Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorIrradiance CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +XIsMirrored | boolean attribute | `bool XIsMirrored` +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +XNbSamples | Number attribute | `uint XNbSamples` +XNbSamplesText | Number attribute (as text) | `string XNbSamplesText` +XResolution | Number attribute | `double XResolution` +XResolutionText | Number attribute (as text) | `string XResolutionText` +YIsMirrored | boolean attribute | `bool YIsMirrored` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +YNbSamples | Number attribute | `uint YNbSamples` +YNbSamplesText | Number attribute (as text) | `string YNbSamplesText` +YResolution | Number attribute | `double YResolution` +YResolutionText | Number attribute (as text) | `string YResolutionText` +OriginPoint | Link attribute | `SpeosSim.SensorIrradiance.SensorIrradianceOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SensorIrradiance.SensorIrradianceXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SensorIrradiance.SensorIrradianceYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +IlluminanceType | Enum attribute | `SpeosSim.SensorIrradiance.EnumIlluminanceType IlluminanceType` +IlluminanceTypeIndex | Enum attribute (as index) | `int IlluminanceTypeIndex` +IntegrationDirection | Link attribute | `SpeosSim.SensorIrradiance.SensorIrradianceIntegrationDirection IntegrationDirection` +IntegrationDirectionIsReversed | boolean attribute | `bool IntegrationDirectionIsReversed` +XMPTemplateFile | File attribute | `string XMPTemplateFile` +XMPTemplateFileFullPath | File attribute (absolute full path) | `string XMPTemplateFileFullPath` +DimensionFromFile | boolean attribute | `bool DimensionFromFile` +DisplayPropertiesFromFile | boolean attribute | `bool DisplayPropertiesFromFile` +SensorType | Enum attribute | `SpeosSim.SensorIrradiance.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +RayFileType | Enum attribute | `SpeosSim.SensorIrradiance.EnumRayFileType RayFileType` +RayFileTypeIndex | Enum attribute (as index) | `int RayFileTypeIndex` +LayerType | Enum attribute | `SpeosSim.SensorIrradiance.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +FaceFiltering | Links attribute | `SpeosSim.SensorIrradiance.SensorIrradianceFaceFiltering FaceFiltering` +SCAFilteringMode | Enum attribute | `SpeosSim.SensorIrradiance.EnumSCAFilteringMode SCAFilteringMode` +SCAFilteringModeIndex | Enum attribute (as index) | `int SCAFilteringModeIndex` +MaximumNbOfSequence | Number attribute | `uint MaximumNbOfSequence` +MaximumNbOfSequenceText | Number attribute (as text) | `string MaximumNbOfSequenceText` +DefineSequencePer | Enum attribute | `SpeosSim.SensorIrradiance.EnumDefineSequencePer DefineSequencePer` +DefineSequencePerIndex | Enum attribute (as index) | `int DefineSequencePerIndex` +SortSequencesPer | Enum attribute | `SpeosSim.SensorIrradiance.EnumSortSequencesPer SortSequencesPer` +SortSequencesPerIndex | Enum attribute (as index) | `int SortSequencesPerIndex` +IncidentAnglesSampling | Number attribute | `uint IncidentAnglesSampling` +IncidentAnglesSamplingText | Number attribute (as text) | `string IncidentAnglesSamplingText` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +OutputFaces | Links attribute | `SpeosSim.SensorIrradiance.SensorIrradianceOutputFaces OutputFaces` +ShowGrid | boolean attribute | `bool ShowGrid` +OriginX | Number attribute | `double OriginX` +OriginXText | Number attribute (as text) | `string OriginXText` +OriginY | Number attribute | `double OriginY` +OriginYText | Number attribute (as text) | `string OriginYText` +StepX | Number attribute | `double StepX` +StepXText | Number attribute (as text) | `string StepXText` +StepY | Number attribute | `double StepY` +StepYText | Number attribute (as text) | `string StepYText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorIrradiance.SensorIrradianceOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIrradiance.SensorIrradianceXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIrradiance.SensorIrradianceYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIrradiance.SensorIrradianceIntegrationDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorIrradiance.SensorIrradianceFaceFiltering + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SensorIrradiance.SensorIrradianceOutputFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SensorLidar + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorLidar Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorLidar Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorLidar Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorLidar Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorLidar CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +LidarType | Enum attribute | `SpeosSim.SensorLidar.EnumLidarType LidarType` +LidarTypeIndex | Enum attribute (as index) | `int LidarTypeIndex` +SystemOriginPoint | Link attribute | `SpeosSim.SensorLidar.SensorLidarSystemOriginPoint SystemOriginPoint` +SystemXDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarSystemXDirection SystemXDirection` +SystemXDirectionReverse | boolean attribute | `bool SystemXDirectionReverse` +SystemYDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarSystemYDirection SystemYDirection` +SystemYDirectionReverse | boolean attribute | `bool SystemYDirectionReverse` +TrajectoryFile | File attribute | `string TrajectoryFile` +TrajectoryFileFullPath | File attribute (absolute full path) | `string TrajectoryFileFullPath` +ScanningSequenceFile | File attribute | `string ScanningSequenceFile` +ScanningSequenceFileFullPath | File attribute (absolute full path) | `string ScanningSequenceFileFullPath` +RotatingSequenceFile | File attribute | `string RotatingSequenceFile` +RotatingSequenceFileFullPath | File attribute (absolute full path) | `string RotatingSequenceFileFullPath` +SourceOriginPoint | Link attribute | `SpeosSim.SensorLidar.SensorLidarSourceOriginPoint SourceOriginPoint` +SourceXDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarSourceXDirection SourceXDirection` +SourceXDirectionReverse | boolean attribute | `bool SourceXDirectionReverse` +SourceXPosition | Number attribute | `double SourceXPosition` +SourceXPositionText | Number attribute (as text) | `string SourceXPositionText` +SourceYDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarSourceYDirection SourceYDirection` +SourceYDirectionReverse | boolean attribute | `bool SourceYDirectionReverse` +SourceYPosition | Number attribute | `double SourceYPosition` +SourceYPositionText | Number attribute (as text) | `string SourceYPositionText` +SpectrumType | Enum attribute | `SpeosSim.SensorLidar.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueWavelength | Number attribute | `double SpectrumValueWavelength` +SpectrumValueWavelengthText | Number attribute (as text) | `string SpectrumValueWavelengthText` +SpectrumValueLibrary | File attribute | `string SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +IntensityType | Enum attribute | `SpeosSim.SensorLidar.EnumIntensityType IntensityType` +IntensityTypeIndex | Enum attribute (as index) | `int IntensityTypeIndex` +IntensityFile | File attribute | `string IntensityFile` +IntensityFileFullPath | File attribute (absolute full path) | `string IntensityFileFullPath` +TotalAngle | Number attribute | `double TotalAngle` +TotalAngleText | Number attribute (as text) | `string TotalAngleText` +FullWidthAtHalfMaximumXAngle | Number attribute | `double FullWidthAtHalfMaximumXAngle` +FullWidthAtHalfMaximumXAngleText | Number attribute (as text) | `string FullWidthAtHalfMaximumXAngleText` +FullWidthAtHalfMaximumYAngle | Number attribute | `double FullWidthAtHalfMaximumYAngle` +FullWidthAtHalfMaximumYAngleText | Number attribute (as text) | `string FullWidthAtHalfMaximumYAngleText` +PulseEnergy | Number attribute | `double PulseEnergy` +PulseEnergyText | Number attribute (as text) | `string PulseEnergyText` +IESThreshold | Number attribute | `double IESThreshold` +IESThresholdText | Number attribute (as text) | `string IESThresholdText` +SensorOriginPoint | Link attribute | `SpeosSim.SensorLidar.SensorLidarSensorOriginPoint SensorOriginPoint` +SensorXDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarSensorXDirection SensorXDirection` +SensorXDirectionReverse | boolean attribute | `bool SensorXDirectionReverse` +SensorYDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarSensorYDirection SensorYDirection` +SensorYDirectionReverse | boolean attribute | `bool SensorYDirectionReverse` +DistorsionFile | File attribute | `string DistorsionFile` +DistorsionFileFullPath | File attribute (absolute full path) | `string DistorsionFileFullPath` +Transmittance | Number attribute | `double Transmittance` +TransmittanceText | Number attribute (as text) | `string TransmittanceText` +TransmittanceSpectrumFile | File attribute | `string TransmittanceSpectrumFile` +TransmittanceSpectrumFileFullPath | File attribute (absolute full path) | `string TransmittanceSpectrumFileFullPath` +FocalLength | Number attribute | `double FocalLength` +FocalLengthText | Number attribute (as text) | `string FocalLengthText` +Pupil | Number attribute | `double Pupil` +PupilText | Number attribute (as text) | `string PupilText` +HorizontalFOV | Number attribute | `double HorizontalFOV` +HorizontalFOVText | Number attribute (as text) | `string HorizontalFOVText` +VerticalFOV | Number attribute | `double VerticalFOV` +VerticalFOVText | Number attribute (as text) | `string VerticalFOVText` +ImagerWidth | Number attribute | `double ImagerWidth` +ImagerWidthText | Number attribute (as text) | `string ImagerWidthText` +ImagerHeight | Number attribute | `double ImagerHeight` +ImagerHeightText | Number attribute (as text) | `string ImagerHeightText` +CustomResolution | boolean attribute | `bool CustomResolution` +HorizontalPixels | Number attribute | `uint HorizontalPixels` +HorizontalPixelsText | Number attribute (as text) | `string HorizontalPixelsText` +VerticalPixels | Number attribute | `uint VerticalPixels` +VerticalPixelsText | Number attribute (as text) | `string VerticalPixelsText` +RangeStart | Number attribute | `double RangeStart` +RangeStartText | Number attribute (as text) | `string RangeStartText` +RangeEnd | Number attribute | `double RangeEnd` +RangeEndText | Number attribute (as text) | `string RangeEndText` +RangeSpatialAccuracy | Number attribute | `double RangeSpatialAccuracy` +RangeSpatialAccuracyText | Number attribute (as text) | `string RangeSpatialAccuracyText` +UserDefined | boolean attribute | `bool UserDefined` +AimingAreaOriginPoint | Link attribute | `SpeosSim.SensorLidar.SensorLidarAimingAreaOriginPoint AimingAreaOriginPoint` +AimingAreaXDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarAimingAreaXDirection AimingAreaXDirection` +AimingAreaXDirectionReverse | boolean attribute | `bool AimingAreaXDirectionReverse` +AimingAreaYDirection | Link attribute | `SpeosSim.SensorLidar.SensorLidarAimingAreaYDirection AimingAreaYDirection` +AimingAreaYDirectionReverse | boolean attribute | `bool AimingAreaYDirectionReverse` +AimingAreaType | Enum attribute | `SpeosSim.SensorLidar.EnumAimingAreaType AimingAreaType` +AimingAreaTypeIndex | Enum attribute (as index) | `int AimingAreaTypeIndex` +AimingAreaWidth | Number attribute | `double AimingAreaWidth` +AimingAreaWidthText | Number attribute (as text) | `string AimingAreaWidthText` +AimingAreaHeight | Number attribute | `double AimingAreaHeight` +AimingAreaHeightText | Number attribute (as text) | `string AimingAreaHeightText` +DisplayImageField | boolean attribute | `bool DisplayImageField` +DisplayObjectField | boolean attribute | `bool DisplayObjectField` +DisplayPupil | boolean attribute | `bool DisplayPupil` +ObjectFieldVisuRadius | Number attribute | `double ObjectFieldVisuRadius` +ObjectFieldVisuRadiusText | Number attribute (as text) | `string ObjectFieldVisuRadiusText` +ColorScaleType | Enum attribute | `SpeosSim.SensorLidar.EnumColorScaleType ColorScaleType` +ColorScaleTypeIndex | Enum attribute (as index) | `int ColorScaleTypeIndex` +ColorScaleFile | File attribute | `string ColorScaleFile` +ColorScaleFileFullPath | File attribute (absolute full path) | `string ColorScaleFileFullPath` +PointThickness | Number attribute | `double PointThickness` +PointThicknessText | Number attribute (as text) | `string PointThicknessText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorLidar.SensorLidarSystemOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSystemXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSystemYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSourceOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSourceXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSourceYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSensorOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSensorXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarSensorYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarAimingAreaOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarAimingAreaXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLidar.SensorLidarAimingAreaYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorLightExpertGroup + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorLightExpertGroup Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorLightExpertGroup Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorLightExpertGroup Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorLightExpertGroup Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorLightExpertGroup CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Sensors | Links attribute | `SpeosSim.SensorLightExpertGroup.SensorLightExpertGroupSensors Sensors` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorLightExpertGroup.SensorLightExpertGroupSensors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SensorLightField + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorLightField Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorLightField Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorLightField Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorLightField Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorLightField CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.SensorLightField.SensorLightFieldOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SensorLightField.SensorLightFieldXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SensorLightField.SensorLightFieldYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +SensorType | Enum attribute | `SpeosSim.SensorLightField.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +OrientedFaces | Children attribute | `SpeosSim.SensorLightField.SensorLightFieldOrientedFaces OrientedFaces` +IncidentAngleStart | Number attribute | `double IncidentAngleStart` +IncidentAngleStartText | Number attribute (as text) | `string IncidentAngleStartText` +IncidentAngleEnd | Number attribute | `double IncidentAngleEnd` +IncidentAngleEndText | Number attribute (as text) | `string IncidentAngleEndText` +IncidentAngleNbSamples | Number attribute | `uint IncidentAngleNbSamples` +IncidentAngleNbSamplesText | Number attribute (as text) | `string IncidentAngleNbSamplesText` +IncidentAngleResolution | Number attribute | `double IncidentAngleResolution` +IncidentAngleResolutionText | Number attribute (as text) | `string IncidentAngleResolutionText` +AzimuthAngleStart | Number attribute | `double AzimuthAngleStart` +AzimuthAngleStartText | Number attribute (as text) | `string AzimuthAngleStartText` +AzimuthAngleEnd | Number attribute | `double AzimuthAngleEnd` +AzimuthAngleEndText | Number attribute (as text) | `string AzimuthAngleEndText` +AzimuthAngleNbSamples | Number attribute | `uint AzimuthAngleNbSamples` +AzimuthAngleNbSamplesText | Number attribute (as text) | `string AzimuthAngleNbSamplesText` +AzimuthAngleResolution | Number attribute | `double AzimuthAngleResolution` +AzimuthAngleResolutionText | Number attribute (as text) | `string AzimuthAngleResolutionText` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorLightField.SensorLightFieldOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLightField.SensorLightFieldXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLightField.SensorLightFieldYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorLightField.SensorLightFieldOrientedFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.OrientedFace childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.OrientedFace Item` + +## SensorObserver + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorObserver Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorObserver Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorObserver Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorObserver Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorObserver CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +ObserverHStart | Number attribute | `double ObserverHStart` +ObserverHStartText | Number attribute (as text) | `string ObserverHStartText` +ObserverHEnd | Number attribute | `double ObserverHEnd` +ObserverHEndText | Number attribute (as text) | `string ObserverHEndText` +ObserverHSampling | Number attribute | `uint ObserverHSampling` +ObserverHSamplingText | Number attribute (as text) | `string ObserverHSamplingText` +ObserverHResolution | Number attribute | `double ObserverHResolution` +ObserverHResolutionText | Number attribute (as text) | `string ObserverHResolutionText` +ObserverHMirrorExtent | boolean attribute | `bool ObserverHMirrorExtent` +ObserverVStart | Number attribute | `double ObserverVStart` +ObserverVStartText | Number attribute (as text) | `string ObserverVStartText` +ObserverVEnd | Number attribute | `double ObserverVEnd` +ObserverVEndText | Number attribute (as text) | `string ObserverVEndText` +ObserverVSampling | Number attribute | `uint ObserverVSampling` +ObserverVSamplingText | Number attribute (as text) | `string ObserverVSamplingText` +ObserverVResolution | Number attribute | `double ObserverVResolution` +ObserverVResolutionText | Number attribute (as text) | `string ObserverVResolutionText` +ObserverVMirrorExtent | boolean attribute | `bool ObserverVMirrorExtent` +SizeHStart | Number attribute | `double SizeHStart` +SizeHStartText | Number attribute (as text) | `string SizeHStartText` +SizeHEnd | Number attribute | `double SizeHEnd` +SizeHEndText | Number attribute (as text) | `string SizeHEndText` +SizeHSampling | Number attribute | `uint SizeHSampling` +SizeHSamplingText | Number attribute (as text) | `string SizeHSamplingText` +SizeHResolution | Number attribute | `double SizeHResolution` +SizeHResolutionText | Number attribute (as text) | `string SizeHResolutionText` +SizeHMirrorExtent | boolean attribute | `bool SizeHMirrorExtent` +SizeVStart | Number attribute | `double SizeVStart` +SizeVStartText | Number attribute (as text) | `string SizeVStartText` +SizeVEnd | Number attribute | `double SizeVEnd` +SizeVEndText | Number attribute (as text) | `string SizeVEndText` +SizeVSampling | Number attribute | `uint SizeVSampling` +SizeVSamplingText | Number attribute (as text) | `string SizeVSamplingText` +SizeVResolution | Number attribute | `double SizeVResolution` +SizeVResolutionText | Number attribute (as text) | `string SizeVResolutionText` +SizeVMirrorExtent | boolean attribute | `bool SizeVMirrorExtent` +Distance | Number attribute | `double Distance` +DistanceText | Number attribute (as text) | `string DistanceText` +Focal | Number attribute | `double Focal` +FocalText | Number attribute (as text) | `string FocalText` +Stereo | boolean attribute | `bool Stereo` +InterocularDistance | Number attribute | `double InterocularDistance` +InterocularDistanceText | Number attribute (as text) | `string InterocularDistanceText` +LayerType | Enum attribute | `SpeosSim.SensorObserver.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +IntegrationAngle | Number attribute | `double IntegrationAngle` +IntegrationAngleText | Number attribute (as text) | `string IntegrationAngleText` +ShowVisionField | boolean attribute | `bool ShowVisionField` +HSensorPreview | Number attribute | `double HSensorPreview` +HSensorPreviewText | Number attribute (as text) | `string HSensorPreviewText` +VSensorPreview | Number attribute | `double VSensorPreview` +VSensorPreviewText | Number attribute (as text) | `string VSensorPreviewText` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +OriginPoint | Link attribute | `SpeosSim.SensorObserver.SensorObserverOriginPoint OriginPoint` +HorizontalDirection | Link attribute | `SpeosSim.SensorObserver.SensorObserverHorizontalDirection HorizontalDirection` +HorizontalDirectionReverse | boolean attribute | `bool HorizontalDirectionReverse` +VerticalDirection | Link attribute | `SpeosSim.SensorObserver.SensorObserverVerticalDirection VerticalDirection` +VerticalDirectionReverse | boolean attribute | `bool VerticalDirectionReverse` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorObserver.SensorObserverOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorObserver.SensorObserverHorizontalDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorObserver.SensorObserverVerticalDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorPhysicalCamera + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorPhysicalCamera Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorPhysicalCamera Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorPhysicalCamera Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorPhysicalCamera Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorPhysicalCamera CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.SensorPhysicalCamera.SensorPhysicalCameraOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SensorPhysicalCamera.SensorPhysicalCameraXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SensorPhysicalCamera.SensorPhysicalCameraYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +LightBoxFile | File attribute | `string LightBoxFile` +LightBoxFileFullPath | File attribute (absolute full path) | `string LightBoxFileFullPath` +NbOfSequences | Number attribute | `int NbOfSequences` +NbOfSequencesText | Number attribute (as text) | `string NbOfSequencesText` +SequenceFile | File attribute | `string SequenceFile` +SequenceFileFullPath | File attribute (absolute full path) | `string SequenceFileFullPath` +SensorIrradiance | Link attribute | `SpeosSim.SensorPhysicalCamera.SensorPhysicalCameraSensorIrradiance SensorIrradiance` +RayTracerPrecision | Enum attribute | `SpeosSim.SensorPhysicalCamera.EnumRayTracerPrecision RayTracerPrecision` +RayTracerPrecisionIndex | Enum attribute (as index) | `int RayTracerPrecisionIndex` +PreviewType | Enum attribute | `SpeosSim.SensorPhysicalCamera.EnumPreviewType PreviewType` +PreviewTypeIndex | Enum attribute (as index) | `int PreviewTypeIndex` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorPhysicalCamera.SensorPhysicalCameraOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorPhysicalCamera.SensorPhysicalCameraXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorPhysicalCamera.SensorPhysicalCameraYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorPhysicalCamera.SensorPhysicalCameraSensorIrradiance + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorRadiance + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorRadiance Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorRadiance Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorRadiance Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorRadiance Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorRadiance CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +DefinitionFrom | Enum attribute | `SpeosSim.SensorRadiance.EnumDefinitionFrom DefinitionFrom` +DefinitionFromIndex | Enum attribute (as index) | `int DefinitionFromIndex` +SensorType | Enum attribute | `SpeosSim.SensorRadiance.EnumSensorType SensorType` +SensorTypeIndex | Enum attribute (as index) | `int SensorTypeIndex` +LayerType | Enum attribute | `SpeosSim.SensorRadiance.EnumLayerType LayerType` +LayerTypeIndex | Enum attribute (as index) | `int LayerTypeIndex` +FaceFiltering | Links attribute | `SpeosSim.SensorRadiance.SensorRadianceFaceFiltering FaceFiltering` +SCAFilteringMode | Enum attribute | `SpeosSim.SensorRadiance.EnumSCAFilteringMode SCAFilteringMode` +SCAFilteringModeIndex | Enum attribute (as index) | `int SCAFilteringModeIndex` +MaximumNbOfSequence | Number attribute | `uint MaximumNbOfSequence` +MaximumNbOfSequenceText | Number attribute (as text) | `string MaximumNbOfSequenceText` +DefineSequencePer | Enum attribute | `SpeosSim.SensorRadiance.EnumDefineSequencePer DefineSequencePer` +DefineSequencePerIndex | Enum attribute (as index) | `int DefineSequencePerIndex` +XMPTemplateFile | File attribute | `string XMPTemplateFile` +XMPTemplateFileFullPath | File attribute (absolute full path) | `string XMPTemplateFileFullPath` +DimensionFromFile | boolean attribute | `bool DimensionFromFile` +DisplayPropertiesFromFile | boolean attribute | `bool DisplayPropertiesFromFile` +WavelengthStart | Number attribute | `double WavelengthStart` +WavelengthStartText | Number attribute (as text) | `string WavelengthStartText` +WavelengthEnd | Number attribute | `double WavelengthEnd` +WavelengthEndText | Number attribute (as text) | `string WavelengthEndText` +WavelengthNbSamples | Number attribute | `uint WavelengthNbSamples` +WavelengthNbSamplesText | Number attribute (as text) | `string WavelengthNbSamplesText` +WavelengthResolution | Number attribute | `double WavelengthResolution` +WavelengthResolutionText | Number attribute (as text) | `string WavelengthResolutionText` +ObserverType | Enum attribute | `SpeosSim.SensorRadiance.EnumObserverType ObserverType` +ObserverTypeIndex | Enum attribute (as index) | `int ObserverTypeIndex` +Focal | Number attribute | `double Focal` +FocalText | Number attribute (as text) | `string FocalText` +IntegrationAngle | Number attribute | `double IntegrationAngle` +IntegrationAngleText | Number attribute (as text) | `string IntegrationAngleText` +XIsMirrored | boolean attribute | `bool XIsMirrored` +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +XNbSamples | Number attribute | `uint XNbSamples` +XNbSamplesText | Number attribute (as text) | `string XNbSamplesText` +XResolution | Number attribute | `double XResolution` +XResolutionText | Number attribute (as text) | `string XResolutionText` +YIsMirrored | boolean attribute | `bool YIsMirrored` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +YNbSamples | Number attribute | `uint YNbSamples` +YNbSamplesText | Number attribute (as text) | `string YNbSamplesText` +YResolution | Number attribute | `double YResolution` +YResolutionText | Number attribute (as text) | `string YResolutionText` +OriginPoint | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +HPlane | Number attribute | `double HPlane` +HPlaneText | Number attribute (as text) | `string HPlaneText` +VPlane | Number attribute | `double VPlane` +VPlaneText | Number attribute (as text) | `string VPlaneText` +HNbSamples | Number attribute | `uint HNbSamples` +HNbSamplesText | Number attribute (as text) | `string HNbSamplesText` +HResolution | Number attribute | `double HResolution` +HResolutionText | Number attribute (as text) | `string HResolutionText` +VNbSamples | Number attribute | `uint VNbSamples` +VNbSamplesText | Number attribute (as text) | `string VNbSamplesText` +VResolution | Number attribute | `double VResolution` +VResolutionText | Number attribute (as text) | `string VResolutionText` +ObserverPoint | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceObserverPoint ObserverPoint` +FocalPoint | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceFocalPoint FocalPoint` +FrontDirection | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceFrontDirection FrontDirection` +FrontDirectionReverse | boolean attribute | `bool FrontDirectionReverse` +TopDirection | Link attribute | `SpeosSim.SensorRadiance.SensorRadianceTopDirection TopDirection` +TopDirectionReverse | boolean attribute | `bool TopDirectionReverse` +ShowGrid | boolean attribute | `bool ShowGrid` +OriginX | Number attribute | `double OriginX` +OriginXText | Number attribute (as text) | `string OriginXText` +OriginY | Number attribute | `double OriginY` +OriginYText | Number attribute (as text) | `string OriginYText` +StepX | Number attribute | `double StepX` +StepXText | Number attribute (as text) | `string StepXText` +StepY | Number attribute | `double StepY` +StepYText | Number attribute (as text) | `string StepYText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorRadiance.SensorRadianceFaceFiltering + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SensorRadiance.SensorRadianceOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRadiance.SensorRadianceXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRadiance.SensorRadianceYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRadiance.SensorRadianceObserverPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRadiance.SensorRadianceFocalPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRadiance.SensorRadianceFrontDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRadiance.SensorRadianceTopDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SensorRotatingLidar + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SensorRotatingLidar Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SensorRotatingLidar Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SensorRotatingLidar Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SensorRotatingLidar Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SensorRotatingLidar CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +OriginPoint | Link attribute | `SpeosSim.SensorRotatingLidar.SensorRotatingLidarOriginPoint OriginPoint` +HorizontalDirection | Link attribute | `SpeosSim.SensorRotatingLidar.SensorRotatingLidarHorizontalDirection HorizontalDirection` +HorizontalDirectionReverse | boolean attribute | `bool HorizontalDirectionReverse` +VerticalDirection | Link attribute | `SpeosSim.SensorRotatingLidar.SensorRotatingLidarVerticalDirection VerticalDirection` +VerticalDirectionReverse | boolean attribute | `bool VerticalDirectionReverse` +ColorScaleType | Enum attribute | `SpeosSim.SensorRotatingLidar.EnumColorScaleType ColorScaleType` +ColorScaleTypeIndex | Enum attribute (as index) | `int ColorScaleTypeIndex` +ColorScaleFile | File attribute | `string ColorScaleFile` +ColorScaleFileFullPath | File attribute (absolute full path) | `string ColorScaleFileFullPath` +HMin | Number attribute | `double HMin` +HMinText | Number attribute (as text) | `string HMinText` +HMax | Number attribute | `double HMax` +HMaxText | Number attribute (as text) | `string HMaxText` +HResolution | Number attribute | `double HResolution` +HResolutionText | Number attribute (as text) | `string HResolutionText` +VerticalChannelFile | File attribute | `string VerticalChannelFile` +VerticalChannelFileFullPath | File attribute (absolute full path) | `string VerticalChannelFileFullPath` +RangeMin | Number attribute | `double RangeMin` +RangeMinText | Number attribute (as text) | `string RangeMinText` +RangeMax | Number attribute | `double RangeMax` +RangeMaxText | Number attribute (as text) | `string RangeMaxText` +PointCloud | boolean attribute | `bool PointCloud` +PointThickness | Number attribute | `double PointThickness` +PointThicknessText | Number attribute (as text) | `string PointThicknessText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SensorRotatingLidar.SensorRotatingLidarOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRotatingLidar.SensorRotatingLidarHorizontalDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SensorRotatingLidar.SensorRotatingLidarVerticalDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SimulationDirect + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationDirect Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationDirect Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationDirect Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationDirect Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationDirect CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +Export | Run the Export command. Output directory content will be erased during process | `void Export(string outputDirectoryPath)` +LinkedExport | Run the LinkedExport command | `void LinkedExport()` +Isolate | Run the Isolate command | `void Isolate()` +GetResultFilePaths | Get the list of paths of all computation resulting files | `System.String[] GetResultFilePaths()` +GetSimulationSettings | Get the simulation common settings | `SpeosSim.SimulationSettings GetSimulationSettings()` +SetSimulationSettings | Set the simulation common settings | `void SetSimulationSettings(SpeosSim.SimulationSettings simulationSettings)` +GetDirectSimulationSettings | Get the direct simulation specific settings | `SpeosSim.Specific.DirectSimulationSettings GetDirectSimulationSettings()` +SetDirectSimulationSettings | Set the direct simulation specific settings | `void SetDirectSimulationSettings(SpeosSim.Specific.DirectSimulationSettings directSimulationSettings) +SetDirectSimulationSettings | Set the direct simulation specific settings | `void SetDirectSimulationSettings(bool fastTransmissionGathering, bool dispersion, int automaticSaveFrequencySeconds) +GpuCompute | Run the GPU Compute command | `void GpuCompute()` +GetEstimatedRam | Get an estimate of the RAM (memory in bytes) that will be required for the simulation results. Returns 'None/Null' if the estimate is not available. | `uint64? GetEstimatedRam()` +DoesRulesSucceed | Will check all rules of all XMP If zero rules found, return false If at least one rule fail, return false | `bool DoesRulesSucceed()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Geometries | Children attribute | `SpeosSim.SimulationDirect.SimulationDirectGeometries Geometries` +RayFileType | Enum attribute | `SpeosSim.SimulationDirect.EnumRayFileType RayFileType` +RayFileTypeIndex | Enum attribute (as index) | `int RayFileTypeIndex` +Sources | Links attribute | `SpeosSim.SimulationDirect.SimulationDirectSources Sources` +Sensors | Children attribute | `SpeosSim.SimulationDirect.SimulationDirectSensors Sensors` +UsesLXP | boolean attribute | `bool UsesLXP` +LXPMaxPath | Number attribute | `int LXPMaxPath` +LXPMaxPathText | Number attribute (as text) | `string LXPMaxPathText` +HasRayNbLimit | boolean attribute | `bool HasRayNbLimit` +NbRays | Number attribute | `System.Int64 NbRays` +NbRaysText | Number attribute (as text) | `string NbRaysText` +HasDurationLimit | boolean attribute | `bool HasDurationLimit` +DurationLimit | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration DurationLimit` +DurationLimitText | Number attribute (as text) | `string DurationLimitText` +AmbientMaterial | File attribute | `string AmbientMaterial` +AmbientMaterialFullPath | File attribute (absolute full path) | `string AmbientMaterialFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SimulationDirect.SimulationDirectGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.FTGEnabledGeometry childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.FTGEnabledGeometry Item` + +### SimulationDirect.SimulationDirectSources + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationDirect.SimulationDirectSensors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.LXPEnabledSensor childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.LXPEnabledSensor Item` + +## SimulationHoa + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationHoa Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationHoa Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationHoa Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationHoa Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationHoa CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetResultFilePaths | Get the list of paths of all computation resulting files | System.String[] GetResultFilePaths()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Eyebox | Child CustomObject attribute | `SpeosSim.HoaEyeBox Eyebox` +TargetImage | Child CustomObject attribute | `SpeosSim.HoaTargetImage TargetImage` +Windshield | Child CustomObject attribute | `SpeosSim.HoaWindshield Windshield` +Mirrors | Child CustomObject attribute | `SpeosSim.HoaMirrors Mirrors` +PGU | Child CustomObject attribute | `SpeosSim.HoaPGU PGU` +Report | Child CustomObject attribute | `SpeosSim.HoaReport Report` +Warping | Child CustomObject attribute | `SpeosSim.HoaWarping Warping` +VehicleAxis | Link attribute | `SpeosSim.SimulationHoa.SimulationHoaVehicleAxis VehicleAxis` +ReverseVehiculeAxisDirection | boolean attribute | `bool ReverseVehiculeAxisDirection` +TopAxis | Link attribute | `SpeosSim.SimulationHoa.SimulationHoaTopAxis TopAxis` +ReverseTopAxisDirection | boolean attribute | `bool ReverseTopAxisDirection` +VisualisationPerEyeboxSample | boolean attribute | `bool VisualisationPerEyeboxSample` +VisualisationPerOpticalVolume | boolean attribute | `bool VisualisationPerOpticalVolume` +ZoomFactor | Number attribute | `int ZoomFactor` +ZoomFactorText | Number attribute (as text) | `string ZoomFactorText` +EyeboxSample | boolean attribute | `bool EyeboxSample` +VisionMode | Enum attribute | `SpeosSim.SimulationHoa.EnumVisionMode VisionMode` +VisionModeIndex | Enum attribute (as index) | `int VisionModeIndex` +HorizontalSample | Number attribute | `int HorizontalSample` +HorizontalSampleText | Number attribute (as text) | `string HorizontalSampleText` +VerticalSample | Number attribute | `int VerticalSample` +VerticalSampleText | Number attribute (as text) | `string VerticalSampleText` +AdaptiveSample | Number attribute | `int AdaptiveSample` +AdaptiveSampleText | Number attribute (as text) | `string AdaptiveSampleText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SimulationHoa.SimulationHoaVehicleAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SimulationHoa.SimulationHoaTopAxis + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SimulationInteractive + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationInteractive Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationInteractive Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationInteractive Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationInteractive Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationInteractive CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +ExportRaysAsGeometry | Export the simulation rays as geometry | `void ExportRaysAsGeometry()` +GetResultFilePaths | Get the list of paths of all computation resulting files | `System.String[] GetResultFilePaths()` +GetSimulationSettings | Get the simulation common settings | `SpeosSim.SimulationSettings GetSimulationSettings()` +SetSimulationSettings | Set the simulation common settings | `void SetSimulationSettings(SpeosSim.SimulationSettings simulationSettings)` +SetInteractiveSimulationSettings | Set the interactive simulation specific settings | `void SetInteractiveSimulationSettings(bool DrawRays, bool DrawImpacts, bool ReportImpact)` +GetInteractiveSimulationSettings | Get the interactive simulation specific settings | `void GetInteractiveSimulationSettings(ref System.Boolean& DrawRays, ref System.Boolean& DrawImpacts, ref System.Boolean& ReportImpact)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +RaysThickness | Number attribute | `int RaysThickness` +RaysThicknessText | Number attribute (as text) | `string RaysThicknessText` +FlagLXPActivation | boolean attribute | `bool FlagLXPActivation` +AmbientMaterial | File attribute | `string AmbientMaterial` +AmbientMaterialFullPath | File attribute (absolute full path) | `string AmbientMaterialFullPath` +Geometries | Links attribute | `SpeosSim.SimulationInteractive.SimulationInteractiveGeometries Geometries` +Sources | Links attribute | `SpeosSim.SimulationInteractive.SimulationInteractiveSources Sources` +Sensors | Links attribute | `SpeosSim.SimulationInteractive.SimulationInteractiveSensors Sensors` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SimulationInteractive.SimulationInteractiveGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationInteractive.SimulationInteractiveSources + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationInteractive.SimulationInteractiveSensors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SimulationInverse + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationInverse Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationInverse Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationInverse Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationInverse Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationInverse CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +Export | Run the Export command. Output directory content will be erase during process | `void Export(string outputDirectoryPath) +LinkedExport | Run the LinkedExport command | `void LinkedExport()` +Isolate | Run the Isolate command | `void Isolate()` +GetResultFilePaths | Get the list of paths of all computation resulting files | `System.String[] GetResultFilePaths()` +GetSimulationSettings | Get the simulation common settings | `SpeosSim.SimulationSettings GetSimulationSettings()` +SetSimulationSettings | Set the simulation common settings | `void SetSimulationSettings(SpeosSim.SimulationSettings simulationSettings)` +GetInverseSimulationSettings | Get the inverse simulation specific settings | `SpeosSim.InverseSimulationSettings GetInverseSimulationSettings()` +SetInverseSimulationSettings | Set the inverse simulation specific settings | `void SetInverseSimulationSettings(SpeosSim.InverseSimulationSettings inverseSimulationSettings) +GpuCompute | Run the GPU Compute command | `void GpuCompute()` +GetEstimatedRam | Get an estimate of the RAM (memory in bytes) that will be required for the simulation results. Returns 'None/Null' if the estimate is not available. | `uint64? GetEstimatedRam()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +UseLXP | boolean attribute | `bool UseLXP` +LXPMaxPaths | Number attribute | `int LXPMaxPaths` +LXPMaxPathsText | Number attribute (as text) | `string LXPMaxPathsText` +AmbientMaterial | File attribute | `string AmbientMaterial` +AmbientMaterialFullPath | File attribute (absolute full path) | `string AmbientMaterialFullPath` +HasTimeline | boolean attribute | `bool HasTimeline` +TimelineStart | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration TimelineStart` +TimelineStartText | Number attribute (as text) | `string TimelineStartText` +Geometries | Children attribute | `SpeosSim.SimulationInverse.SimulationInverseGeometries Geometries` +Sources | Links attribute | `SpeosSim.SimulationInverse.SimulationInverseSources Sources` +Sensors | Children attribute | `SpeosSim.SimulationInverse.SimulationInverseSensors Sensors` +OutputFaces | Links attribute | `SpeosSim.SimulationInverse.SimulationInverseOutputFaces OutputFaces` +OutputSources | Links attribute | `SpeosSim.SimulationInverse.SimulationInverseOutputSources OutputSources` +NbPassesStop | boolean attribute | `bool NbPassesStop` +NbPassesLimit | Number attribute | `uint NbPassesLimit` +NbPassesLimitText | Number attribute (as text) | `string NbPassesLimitText` +DurationStop | boolean attribute | `bool DurationStop` +DurationLimit | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration DurationLimit` +DurationLimitText | Number attribute (as text) | `string DurationLimitText` +RelativeStop | Number attribute | `System.Int64 RelativeStop` +RelativeStopText | Number attribute (as text) | `string RelativeStopText` +AbsoluteStop | Number attribute | `System.Int64 AbsoluteStop` +AbsoluteStopText | Number attribute (as text) | `string AbsoluteStopText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SimulationInverse.SimulationInverseGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.FTGEnabledGeometry childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.FTGEnabledGeometry Item` + +### SimulationInverse.SimulationInverseSources + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationInverse.SimulationInverseSensors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.LXPEnabledSensor childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.LXPEnabledSensor Item` + +### SimulationInverse.SimulationInverseOutputFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationInverse.SimulationInverseOutputSources + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SimulationIsolated + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationIsolated Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationIsolated Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationIsolated Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationIsolated Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationIsolated CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## SimulationLidar + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationLidar Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationLidar Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationLidar Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationLidar Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationLidar CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +Export | Run the Export command. Output directory content will be erase during process | `void Export(string outputDirectoryPath)` +LinkedExport | Run the LinkedExport command | `void LinkedExport()` +Isolate | Run the Isolate command | `void Isolate()` +GetResultFilePaths | Get the list of paths of all computation resulting files | `System.String[] GetResultFilePaths()` +GetSimulationSettings | Get the simulation common settings | `SpeosSim.SimulationSettings GetSimulationSettings()` +SetSimulationSettings | Set the simulation common settings | `void SetSimulationSettings(SpeosSim.SimulationSettings simulationSettings)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Geometries | Links attribute | `SpeosSim.SimulationLidar.SimulationLidarGeometries Geometries` +Sensors | Links attribute | `SpeosSim.SimulationLidar.SimulationLidarSensors Sensors` +HasRayNumberLimit | boolean attribute | `bool HasRayNumberLimit` +NumberOfRays | Number attribute | `System.Int64 NumberOfRays` +NumberOfRaysText | Number attribute (as text) | `string NumberOfRaysText` +HasDurationLimit | boolean attribute | `bool HasDurationLimit` +DurationLimit | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration DurationLimit` +DurationLimitText | Number attribute (as text) | `string DurationLimitText` +SourceSampling | Number attribute | `uint SourceSampling` +SourceSamplingText | Number attribute (as text) | `string SourceSamplingText` +SensorSampling | Number attribute | `uint SensorSampling` +SensorSamplingText | Number attribute (as text) | `string SensorSamplingText` +AmbientMaterial | File attribute | `string AmbientMaterial` +AmbientMaterialFullPath | File attribute (absolute full path) | `string AmbientMaterialFullPath` +HasTimeline | boolean attribute | `bool HasTimeline` +FieldsOfView | boolean attribute | `bool FieldsOfView` +GeometricVisualization | Enum attribute | `SpeosSim.SimulationLidar.EnumGeometricVisualization GeometricVisualization` +GeometricVisualizationIndex | Enum attribute (as index) | `int GeometricVisualizationIndex` +MapOfDepth | boolean attribute | `bool MapOfDepth` +RawTimeOfFlight | boolean attribute | `bool RawTimeOfFlight` +TimelineStart | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration TimelineStart` +TimelineStartText | Number attribute (as text) | `string TimelineStartText` +TimelineEnd | Time duration attribute : can either be defined by a Double or a TimeSpan value | `Fou.Utils.ValueObjects.TimeDuration TimelineEnd` +TimelineEndText | Number attribute (as text) | `string TimelineEndText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SimulationLidar.SimulationLidarGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationLidar.SimulationLidarSensors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SimulationLinkedExport + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationLinkedExport Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationLinkedExport Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationLinkedExport Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationLinkedExport Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationLinkedExport CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +SpeosSimulationFile | File attribute | `string SpeosSimulationFile +SpeosSimulationFileFullPath | File attribute (absolute full path) | `string SpeosSimulationFileFullPath +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +## SimulationRotatingLidar + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SimulationRotatingLidar Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SimulationRotatingLidar Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SimulationRotatingLidar Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SimulationRotatingLidar Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SimulationRotatingLidar CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetResultFilePaths | Get the list of paths of all computation resulting files | `System.String[] GetResultFilePaths()` +GetSimulationSettings | Get the simulation common settings | `SpeosSim.SimulationSettings GetSimulationSettings()` +SetSimulationSettings | Set the simulation common settings | `void SetSimulationSettings(SpeosSim.SimulationSettings simulationSettings)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Geometries | Links attribute | `SpeosSim.SimulationRotatingLidar.SimulationRotatingLidarGeometries Geometries` +Sensors | Links attribute | `SpeosSim.SimulationRotatingLidar.SimulationRotatingLidarSensors Sensors` +Visualization | Enum attribute | `SpeosSim.SimulationRotatingLidar.EnumVisualization Visualization` +VisualizationIndex | Enum attribute (as index) | `int VisualizationIndex` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SimulationRotatingLidar.SimulationRotatingLidarGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SimulationRotatingLidar.SimulationRotatingLidarSensors + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## Sop + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.Sop Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Reference | string attribute | `string Reference` +Reflectance | Number attribute | `double Reflectance` +ReflectanceText | Number attribute (as text) | `string ReflectanceText` + +## SourceAmbientCIEGeneral + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceAmbientCIEGeneral Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceAmbientCIEGeneral Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceAmbientCIEGeneral Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceAmbientCIEGeneral Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceAmbientCIEGeneral CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetLocationPossibleValues | string list attribute: List possible values | `IEnumerable GetLocationPossibleValues()` +GetTimeZonePossibleValues | string list attribute: List possible values | `IEnumerable GetTimeZonePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PreviewSize | Number attribute | `double PreviewSize` +PreviewSizeText | Number attribute (as text) | `string PreviewSizeText` +ZenithDirection | Link attribute | `SpeosSim.SourceAmbientCIEGeneral.SourceAmbientCIEGeneralZenithDirection ZenithDirection` +ZenithDirectionReverse | boolean attribute | `bool ZenithDirectionReverse` +CIEType | Enum attribute | `SpeosSim.SourceAmbientCIEGeneral.EnumCIEType CIEType` +CIETypeIndex | Enum attribute (as index) | `int CIETypeIndex` +Luminance | Number attribute | `double Luminance` +LuminanceText | Number attribute (as text) | `string LuminanceText` +SunType | Enum attribute | `SpeosSim.SourceAmbientCIEGeneral.EnumSunType SunType` +SunTypeIndex | Enum attribute (as index) | `int SunTypeIndex` +NorthDirection | Link attribute | `SpeosSim.SourceAmbientCIEGeneral.SourceAmbientCIEGeneralNorthDirection NorthDirection` +NorthDirectionReverse | boolean attribute | `bool NorthDirectionReverse` +SunDirection | Link attribute | `SpeosSim.SourceAmbientCIEGeneral.SourceAmbientCIEGeneralSunDirection SunDirection` +SunDirectionReverse | boolean attribute | `bool SunDirectionReverse` +SunThetaPosition | Number attribute | `double SunThetaPosition` +SunThetaPositionText | Number attribute (as text) | `string SunThetaPositionText` +SunPhiPosition | Number attribute | `double SunPhiPosition` +SunPhiPositionText | Number attribute (as text) | `string SunPhiPositionText` +Location | string list selection attribute | `string Location` +TimeZone | string list selection attribute | `string TimeZone` +Longitude | Number attribute | `double Longitude` +LongitudeText | Number attribute (as text) | `string LongitudeText` +Latitude | Number attribute | `double Latitude` +LatitudeText | Number attribute (as text) | `string LatitudeText` +DateTime | Number attribute | `System.DateTime DateTime` +DateTimeText | Number attribute (as text) | `string DateTimeText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceAmbientCIEGeneral.SourceAmbientCIEGeneralZenithDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientCIEGeneral.SourceAmbientCIEGeneralNorthDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientCIEGeneral.SourceAmbientCIEGeneralSunDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceAmbientCIEOvercast + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceAmbientCIEOvercast Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceAmbientCIEOvercast Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceAmbientCIEOvercast Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceAmbientCIEOvercast Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceAmbientCIEOvercast CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PreviewSize | Number attribute | `double PreviewSize` +PreviewSizeText | Number attribute (as text) | `string PreviewSizeText` +ZenithDirection | Link attribute | `SpeosSim.SourceAmbientCIEOvercast.SourceAmbientCIEOvercastZenithDirection ZenithDirection` +ZenithDirectionReverse | boolean attribute | `bool ZenithDirectionReverse` +Luminance | Number attribute | `double Luminance` +LuminanceText | Number attribute (as text) | `string LuminanceText` +SpectrumType | Enum attribute | `SpeosSim.SourceAmbientCIEOvercast.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +SpectrumValueLibrary | File attribute | `string SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceAmbientCIEOvercast.SourceAmbientCIEOvercastZenithDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceAmbientEnvironment + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceAmbientEnvironment Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceAmbientEnvironment Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceAmbientEnvironment Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceAmbientEnvironment Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceAmbientEnvironment CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PreviewSize | Number attribute | `double PreviewSize` +PreviewSizeText | Number attribute (as text) | `string PreviewSizeText` +ZenithDirection | Link attribute | `SpeosSim.SourceAmbientEnvironment.SourceAmbientEnvironmentZenithDirection ZenithDirection` +ZenithDirectionReverse | boolean attribute | `bool ZenithDirectionReverse` +NorthDirection | Link attribute | `SpeosSim.SourceAmbientEnvironment.SourceAmbientEnvironmentNorthDirection NorthDirection` +NorthDirectionReverse | boolean attribute | `bool NorthDirectionReverse` +Luminance | Number attribute | `double Luminance` +LuminanceText | Number attribute (as text) | `string LuminanceText` +ImageFile | File attribute | `string ImageFile` +ImageFileFullPath | File attribute (absolute full path) | `string ImageFileFullPath` +ColorSpace | Enum attribute | `SpeosSim.SourceAmbientEnvironment.EnumColorSpace ColorSpace` +ColorSpaceIndex | Enum attribute (as index) | `int ColorSpaceIndex` +WhitePointType | Enum attribute | `SpeosSim.SourceAmbientEnvironment.EnumWhitePointType WhitePointType` +WhitePointTypeIndex | Enum attribute (as index) | `int WhitePointTypeIndex` +xColor | Number attribute | `double xColor` +xColorText | Number attribute (as text) | `string xColorText` +yColor | Number attribute | `double yColor` +yColorText | Number attribute (as text) | `string yColorText` +RedSpectrumValueLibrary | File attribute | `string RedSpectrumValueLibrary` +RedSpectrumValueLibraryFullPath | File attribute (absolute full path) | `string RedSpectrumValueLibraryFullPath` +GreenSpectrumValueLibrary | File attribute | `string GreenSpectrumValueLibrary` +GreenSpectrumValueLibraryFullPath | File attribute (absolute full path) | `string GreenSpectrumValueLibraryFullPath` +BlueSpectrumValueLibrary | File attribute | `string BlueSpectrumValueLibrary` +BlueSpectrumValueLibraryFullPath | File attribute (absolute full path) | `string BlueSpectrumValueLibraryFullPath` +GroundPlaneOriginPoint | Link attribute | `SpeosSim.SourceAmbientEnvironment.SourceAmbientEnvironmentGroundPlaneOriginPoint GroundPlaneOriginPoint` +GroundPlaneHeight | Number attribute | `double GroundPlaneHeight` +GroundPlaneHeightText | Number attribute (as text) | `string GroundPlaneHeightText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceAmbientEnvironment.SourceAmbientEnvironmentZenithDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientEnvironment.SourceAmbientEnvironmentNorthDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientEnvironment.SourceAmbientEnvironmentGroundPlaneOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceAmbientNaturalLight + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceAmbientNaturalLight Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceAmbientNaturalLight Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceAmbientNaturalLight Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceAmbientNaturalLight Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceAmbientNaturalLight CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetLocationPossibleValues | string list attribute: List possible values | `IEnumerable GetLocationPossibleValues()` +GetTimeZonePossibleValues | string list attribute: List possible values | `IEnumerable GetTimeZonePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PreviewSize | Number attribute | `double PreviewSize` +PreviewSizeText | Number attribute (as text) | `string PreviewSizeText` +ZenithDirection | Link attribute | `SpeosSim.SourceAmbientNaturalLight.SourceAmbientNaturalLightZenithDirection ZenithDirection` +ZenithDirectionReverse | boolean attribute | `bool ZenithDirectionReverse` +Turbidity | Number attribute | `double Turbidity` +TurbidityText | Number attribute (as text) | `string TurbidityText` +SunType | Enum attribute | `SpeosSim.SourceAmbientNaturalLight.EnumSunType SunType` +SunTypeIndex | Enum attribute (as index) | `int SunTypeIndex` +NorthDirection | Link attribute | `SpeosSim.SourceAmbientNaturalLight.SourceAmbientNaturalLightNorthDirection NorthDirection` +NorthDirectionReverse | boolean attribute | `bool NorthDirectionReverse` +SunDirection | Link attribute | `SpeosSim.SourceAmbientNaturalLight.SourceAmbientNaturalLightSunDirection SunDirection` +SunDirectionReverse | boolean attribute | `bool SunDirectionReverse` +SimulationWithSky | boolean attribute | `bool SimulationWithSky` +SunThetaPosition | Number attribute | `double SunThetaPosition` +SunThetaPositionText | Number attribute (as text) | `string SunThetaPositionText` +SunPhiPosition | Number attribute | `double SunPhiPosition` +SunPhiPositionText | Number attribute (as text) | `string SunPhiPositionText` +Location | string list selection attribute | `string Location` +TimeZone | string list selection attribute | `string TimeZone` +Longitude | Number attribute | `double Longitude` +LongitudeText | Number attribute (as text) | `string LongitudeText` +Latitude | Number attribute | `double Latitude` +LatitudeText | Number attribute (as text) | `string LatitudeText` +DateTime | Number attribute | `System.DateTime DateTime` +DateTimeText | Number attribute (as text) | `string DateTimeText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceAmbientNaturalLight.SourceAmbientNaturalLightZenithDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientNaturalLight.SourceAmbientNaturalLightNorthDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientNaturalLight.SourceAmbientNaturalLightSunDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceAmbientUniform + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceAmbientUniform Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceAmbientUniform Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceAmbientUniform Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceAmbientUniform Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceAmbientUniform CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PreviewSize | Number attribute | `double PreviewSize` +PreviewSizeText | Number attribute (as text) | `string PreviewSizeText` +ZenithDirection | Link attribute | `SpeosSim.SourceAmbientUniform.SourceAmbientUniformZenithDirection ZenithDirection` +ZenithDirectionReverse | boolean attribute | `bool ZenithDirectionReverse` +Luminance | Number attribute | `double Luminance` +LuminanceText | Number attribute (as text) | `string LuminanceText` +MirroredExtent | boolean attribute | `bool MirroredExtent` +IsSun | boolean attribute | `bool IsSun` +SunDirection | Link attribute | `SpeosSim.SourceAmbientUniform.SourceAmbientUniformSunDirection SunDirection` +SunDirectionReverse | boolean attribute | `bool SunDirectionReverse` +SunThetaPosition | Number attribute | `double SunThetaPosition` +SunThetaPositionText | Number attribute (as text) | `string SunThetaPositionText` +SunPhiPosition | Number attribute | `double SunPhiPosition` +SunPhiPositionText | Number attribute (as text) | `string SunPhiPositionText` +SpectrumType | Enum attribute | `SpeosSim.SourceAmbientUniform.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +SpectrumValueLibrary | File attribute | `string SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceAmbientUniform.SourceAmbientUniformZenithDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientUniform.SourceAmbientUniformSunDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceAmbientUS1976 + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceAmbientUS1976 Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceAmbientUS1976 Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceAmbientUS1976 Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceAmbientUS1976 Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceAmbientUS1976 CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +GetLocationPossibleValues | string list attribute: List possible values | `IEnumerable GetLocationPossibleValues()` +GetTimeZonePossibleValues | string list attribute: List possible values | `IEnumerable GetTimeZonePossibleValues()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +PreviewSize | Number attribute | `double PreviewSize` +PreviewSizeText | Number attribute (as text) | `string PreviewSizeText` +ZenithDirection | Link attribute | `SpeosSim.SourceAmbientUS1976.SourceAmbientUS1976ZenithDirection ZenithDirection` +ZenithDirectionReverse | boolean attribute | `bool ZenithDirectionReverse` +SunType | Enum attribute | `SpeosSim.SourceAmbientUS1976.EnumSunType SunType` +SunTypeIndex | Enum attribute (as index) | `int SunTypeIndex` +NorthDirection | Link attribute | `SpeosSim.SourceAmbientUS1976.SourceAmbientUS1976NorthDirection NorthDirection` +NorthDirectionReverse | boolean attribute | `bool NorthDirectionReverse` +SunDirection | Link attribute | `SpeosSim.SourceAmbientUS1976.SourceAmbientUS1976SunDirection SunDirection` +SunDirectionReverse | boolean attribute | `bool SunDirectionReverse` +SunThetaPosition | Number attribute | `double SunThetaPosition` +SunThetaPositionText | Number attribute (as text) | `string SunThetaPositionText` +SunPhiPosition | Number attribute | `double SunPhiPosition` +SunPhiPositionText | Number attribute (as text) | `string SunPhiPositionText` +Location | string list selection attribute | `string Location` +TimeZone | string list selection attribute | `string TimeZone` +Longitude | Number attribute | `double Longitude` +LongitudeText | Number attribute (as text) | `string LongitudeText` +Latitude | Number attribute | `double Latitude` +LatitudeText | Number attribute (as text) | `string LatitudeText` +DateTime | Number attribute | `System.DateTime DateTime` +DateTimeText | Number attribute (as text) | `string DateTimeText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceAmbientUS1976.SourceAmbientUS1976ZenithDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientUS1976.SourceAmbientUS1976NorthDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceAmbientUS1976.SourceAmbientUS1976SunDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceDisplay + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceDisplay Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceDisplay Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceDisplay Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceDisplay Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceDisplay CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +NbRays | Number attribute | `uint NbRays` +NbRaysText | Number attribute (as text) | `string NbRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +OriginPoint | Link attribute | `SpeosSim.SourceDisplay.SourceDisplayOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SourceDisplay.SourceDisplayXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SourceDisplay.SourceDisplayYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +ImageFile | File attribute | `string ImageFile` +ImageFileFullPath | File attribute (absolute full path) | `string ImageFileFullPath` +XIsMirrored | boolean attribute | `bool XIsMirrored` +XStart | Number attribute | `double XStart` +XStartText | Number attribute (as text) | `string XStartText` +XEnd | Number attribute | `double XEnd` +XEndText | Number attribute (as text) | `string XEndText` +YIsMirrored | boolean attribute | `bool YIsMirrored` +YStart | Number attribute | `double YStart` +YStartText | Number attribute (as text) | `string YStartText` +YEnd | Number attribute | `double YEnd` +YEndText | Number attribute (as text) | `string YEndText` +Luminance | Number attribute | `double Luminance` +LuminanceText | Number attribute (as text) | `string LuminanceText` +InfiniteContrastRatio | boolean attribute | `bool InfiniteContrastRatio` +ContrastRatio | Number attribute | `uint ContrastRatio` +ContrastRatioText | Number attribute (as text) | `string ContrastRatioText` +IntensityType | Enum attribute | `SpeosSim.SourceDisplay.EnumIntensityType IntensityType` +IntensityTypeIndex | Enum attribute (as index) | `int IntensityTypeIndex` +IntensityFile | File attribute | `string IntensityFile` +IntensityFileFullPath | File attribute (absolute full path) | `string IntensityFileFullPath` +IntensityN | Number attribute | `double IntensityN` +IntensityNText | Number attribute (as text) | `string IntensityNText` +IntensityTotalAngle | Number attribute | `double IntensityTotalAngle` +IntensityTotalAngleText | Number attribute (as text) | `string IntensityTotalAngleText` +IntensityFWHMAngle | Number attribute | `double IntensityFWHMAngle` +IntensityFWHMAngleText | Number attribute (as text) | `string IntensityFWHMAngleText` +IntensityFWHMAngleX | Number attribute | `double IntensityFWHMAngleX` +IntensityFWHMAngleXText | Number attribute (as text) | `string IntensityFWHMAngleXText` +IntensityFWHMAngleY | Number attribute | `double IntensityFWHMAngleY` +IntensityFWHMAngleYText | Number attribute (as text) | `string IntensityFWHMAngleYText` +IntensityXDirection | Link attribute | `SpeosSim.SourceDisplay.SourceDisplayIntensityXDirection IntensityXDirection` +IntensityXDirectionReverse | boolean attribute | `bool IntensityXDirectionReverse` +IntensityYDirection | Link attribute | `SpeosSim.SourceDisplay.SourceDisplayIntensityYDirection IntensityYDirection` +IntensityYDirectionReverse | boolean attribute | `bool IntensityYDirectionReverse` +ColorSpace | Enum attribute | `SpeosSim.SourceDisplay.EnumColorSpace ColorSpace` +ColorSpaceIndex | Enum attribute (as index) | `int ColorSpaceIndex` +WhitePointType | Enum attribute | `SpeosSim.SourceDisplay.EnumWhitePointType WhitePointType` +WhitePointTypeIndex | Enum attribute (as index) | `int WhitePointTypeIndex` +xColor | Number attribute | `double xColor` +xColorText | Number attribute (as text) | `string xColorText` +yColor | Number attribute | `double yColor` +yColorText | Number attribute (as text) | `string yColorText` +RedSpectrumValueLibrary | File attribute | `string RedSpectrumValueLibrary` +RedSpectrumValueLibraryFullPath | File attribute (absolute full path) | `string RedSpectrumValueLibraryFullPath` +GreenSpectrumValueLibrary | File attribute | `string GreenSpectrumValueLibrary` +GreenSpectrumValueLibraryFullPath | File attribute (absolute full path) | `string GreenSpectrumValueLibraryFullPath` +BlueSpectrumValueLibrary | File attribute | `string BlueSpectrumValueLibrary` +BlueSpectrumValueLibraryFullPath | File attribute (absolute full path) | `string BlueSpectrumValueLibraryFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceDisplay.SourceDisplayOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceDisplay.SourceDisplayXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceDisplay.SourceDisplayYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceDisplay.SourceDisplayIntensityXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceDisplay.SourceDisplayIntensityYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceInteractive + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceInteractive Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceInteractive Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceInteractive Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceInteractive Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceInteractive CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Wavelength | Number attribute | `double Wavelength` +WavelengthText | Number attribute (as text) | `string WavelengthText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +StartType | Enum attribute | `SpeosSim.SourceInteractive.EnumStartType StartType` +StartTypeIndex | Enum attribute (as index) | `int StartTypeIndex` +StartGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveStartGeometries StartGeometries` +StartCurveGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveStartCurveGeometries StartCurveGeometries` +StartFaceGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveStartFaceGeometries StartFaceGeometries` +StartXSampling | Number attribute | `uint StartXSampling` +StartXSamplingText | Number attribute (as text) | `string StartXSamplingText` +StartYSampling | Number attribute | `uint StartYSampling` +StartYSamplingText | Number attribute (as text) | `string StartYSamplingText` +EndType | Enum attribute | `SpeosSim.SourceInteractive.EnumEndType EndType` +EndTypeIndex | Enum attribute (as index) | `int EndTypeIndex` +EndGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveEndGeometries EndGeometries` +EndCurveGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveEndCurveGeometries EndCurveGeometries` +EndDirectionGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveEndDirectionGeometries EndDirectionGeometries` +EndFaceGeometries | Links attribute | `SpeosSim.SourceInteractive.SourceInteractiveEndFaceGeometries EndFaceGeometries` +EndXSampling | Number attribute | `uint EndXSampling` +EndXSamplingText | Number attribute (as text) | `string EndXSamplingText` +EndYSampling | Number attribute | `uint EndYSampling` +EndYSamplingText | Number attribute (as text) | `string EndYSamplingText` +ReverseDirection | boolean attribute | `bool ReverseDirection` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceInteractive.SourceInteractiveStartGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceInteractive.SourceInteractiveStartCurveGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceInteractive.SourceInteractiveStartFaceGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceInteractive.SourceInteractiveEndGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceInteractive.SourceInteractiveEndCurveGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceInteractive.SourceInteractiveEndDirectionGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceInteractive.SourceInteractiveEndFaceGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SourceLightField + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceLightField Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceLightField Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceLightField Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceLightField Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceLightField CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +NbRays | Number attribute | `uint NbRays` +NbRaysText | Number attribute (as text) | `string NbRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +LightFieldPreviewType | Enum attribute | `SpeosSim.SourceLightField.EnumLightFieldPreviewType LightFieldPreviewType` +LightFieldPreviewTypeIndex | Enum attribute (as index) | `int LightFieldPreviewTypeIndex` +OriginPoint | Link attribute | `SpeosSim.SourceLightField.SourceLightFieldOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SourceLightField.SourceLightFieldXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SourceLightField.SourceLightFieldYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +LightFieldFile | File attribute | `string LightFieldFile` +LightFieldFileFullPath | File attribute (absolute full path) | `string LightFieldFileFullPath` +SpectrumFile | File attribute | `string SpectrumFile` +SpectrumFileFullPath | File attribute (absolute full path) | `string SpectrumFileFullPath` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceLightField.SourceLightFieldOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceLightField.SourceLightFieldXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceLightField.SourceLightFieldYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceLuminaire + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceLuminaire Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceLuminaire Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceLuminaire Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceLuminaire Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceLuminaire CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +NbRays | Number attribute | `uint NbRays` +NbRaysText | Number attribute (as text) | `string NbRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +DisplayIntensityDiagram | boolean attribute | `bool DisplayIntensityDiagram` +IntensityDiagramFixedSize | boolean attribute | `bool IntensityDiagramFixedSize` +IntensityDiagramSize | Number attribute | `double IntensityDiagramSize` +IntensityDiagramSizeText | Number attribute (as text) | `string IntensityDiagramSizeText` +FluxFromIntensityFile | boolean attribute | `bool FluxFromIntensityFile` +FluxType | Enum attribute | `SpeosSim.SourceLuminaire.EnumFluxType FluxType` +FluxTypeIndex | Enum attribute (as index) | `int FluxTypeIndex` +FluxValueLuminous | Number attribute | `double FluxValueLuminous` +FluxValueLuminousText | Number attribute (as text) | `string FluxValueLuminousText` +FluxValueRadiant | Number attribute | `double FluxValueRadiant` +FluxValueRadiantText | Number attribute (as text) | `string FluxValueRadiantText` +SpectrumType | Enum attribute | `SpeosSim.SourceLuminaire.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +SpectrumValueLibrary | File attribute | `string SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +IntensityFile | File attribute | `string IntensityFile` +IntensityFileFullPath | File attribute (absolute full path) | `string IntensityFileFullPath` +OriginPoint | Link attribute | `SpeosSim.SourceLuminaire.SourceLuminaireOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SourceLuminaire.SourceLuminaireXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SourceLuminaire.SourceLuminaireYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceLuminaire.SourceLuminaireOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceLuminaire.SourceLuminaireXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceLuminaire.SourceLuminaireYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceRayFile + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceRayFile Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceRayFile Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceRayFile Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceRayFile Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceRayFile CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +OptimizeRayFile | Call the 'Ray file optimization' command. Returns 'false' if this action is unavailable in the current state of the object. | `bool OptimizeRayFile()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +NbRays | Number attribute | `uint NbRays +NbRaysText | Number attribute (as text) | `string NbRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +ExitGeometry | Links attribute | `SpeosSim.SourceRayFile.SourceRayFileExitGeometry ExitGeometry` +FluxType | Enum attribute | `SpeosSim.SourceRayFile.EnumFluxType FluxType` +FluxTypeIndex | Enum attribute (as index) | `int FluxTypeIndex` +FluxFromRayFile | boolean attribute | `bool FluxFromRayFile` +FluxValueLuminous | Number attribute | `double FluxValueLuminous` +FluxValueLuminousText | Number attribute (as text) | `string FluxValueLuminousText` +FluxValueRadiant | Number attribute | `double FluxValueRadiant` +FluxValueRadiantText | Number attribute (as text) | `string FluxValueRadiantText` +RayFile | File attribute | `Fou.Utils.ValueObjects.FilePath RayFile` +RayFileFullPath | File attribute (absolute full path) | `string RayFileFullPath` +SpectrumType | Enum attribute | `SpeosSim.SourceRayFile.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueWavelength | Number attribute | `double SpectrumValueWavelength` +SpectrumValueWavelengthText | Number attribute (as text) | `string SpectrumValueWavelengthText` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +SpectrumValueLibrary | File attribute | `string SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +OriginPoint | Link attribute | `SpeosSim.SourceRayFile.SourceRayFileOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SourceRayFile.SourceRayFileXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SourceRayFile.SourceRayFileYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceRayFile.SourceRayFileExitGeometry + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### SourceRayFile.SourceRayFileOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceRayFile.SourceRayFileXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceRayFile.SourceRayFileYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SourceSurface + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceSurface Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceSurface Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceSurface Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceSurface Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +NbRays | Number attribute | `uint NbRays` +NbRaysText | Number attribute (as text) | `string NbRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +DisplayIntensityDiagram | boolean attribute | `bool DisplayIntensityDiagram` +IntensityDiagramFixedSize | boolean attribute | `bool IntensityDiagramFixedSize` +IntensityDiagramSize | Number attribute | `double IntensityDiagramSize` +IntensityDiagramSizeText | Number attribute (as text) | `string IntensityDiagramSizeText` +FluxFromIntensityFile | boolean attribute | `bool FluxFromIntensityFile` +FluxType | Enum attribute | `SpeosSim.SourceSurface.EnumFluxType FluxType` +FluxTypeIndex | Enum attribute (as index) | `int FluxTypeIndex` +FluxValueLuminous | Number attribute | `double FluxValueLuminous` +FluxValueLuminousText | Number attribute (as text) | `string FluxValueLuminousText` +FluxValueRadiant | Number attribute | `double FluxValueRadiant` +FluxValueRadiantText | Number attribute (as text) | `string FluxValueRadiantText` +FluxValueIntensity | Number attribute | `double FluxValueIntensity` +FluxValueIntensityText | Number attribute (as text) | `string FluxValueIntensityText` +ExitanceVariable | boolean attribute | `bool ExitanceVariable` +EmissiveFaces | Children attribute | `SpeosSim.SourceSurface.SourceSurfaceEmissiveFaces EmissiveFaces` +ExitanceFile | File attribute | `string ExitanceFile` +ExitanceFileFullPath | File attribute (absolute full path) | `string ExitanceFileFullPath` +ExitanceReverse | boolean attribute | `bool ExitanceReverse` +ExitanceOriginPoint | Link attribute | `SpeosSim.SourceSurface.SourceSurfaceExitanceOriginPoint ExitanceOriginPoint` +ExitanceXDirection | Link attribute | `SpeosSim.SourceSurface.SourceSurfaceExitanceXDirection ExitanceXDirection` +ExitanceXDirectionReverse | boolean attribute | `bool ExitanceXDirectionReverse` +ExitanceYDirection | Link attribute | `SpeosSim.SourceSurface.SourceSurfaceExitanceYDirection ExitanceYDirection` +ExitanceYDirectionReverse | boolean attribute | `bool ExitanceYDirectionReverse` +IntensityType | Enum attribute | `SpeosSim.SourceSurface.EnumIntensityType IntensityType` +IntensityTypeIndex | Enum attribute (as index) | `int IntensityTypeIndex` +IntensityFile | File attribute | `string IntensityFile` +IntensityFileFullPath | File attribute (absolute full path) | `string IntensityFileFullPath` +IntensityN | Number attribute | `double IntensityN` +IntensityNText | Number attribute (as text) | `string IntensityNText` +IntensityTotalAngle | Number attribute | `double IntensityTotalAngle` +IntensityTotalAngleText | Number attribute (as text) | `string IntensityTotalAngleText` +IntensityFWHMAngle | Number attribute | `double IntensityFWHMAngle` +IntensityFWHMAngleText | Number attribute (as text) | `string IntensityFWHMAngleText` +IntensityFWHMAngleX | Number attribute | `double IntensityFWHMAngleX` +IntensityFWHMAngleXText | Number attribute (as text) | `string IntensityFWHMAngleXText` +IntensityFWHMAngleY | Number attribute | `double IntensityFWHMAngleY` +IntensityFWHMAngleYText | Number attribute (as text) | `string IntensityFWHMAngleYText` +IntensityOrientation | Enum attribute | `SpeosSim.SourceSurface.EnumIntensityOrientation IntensityOrientation` +IntensityOrientationIndex | Enum attribute (as index) | `int IntensityOrientationIndex` +IntensityXDirection | Link attribute | `SpeosSim.SourceSurface.SourceSurfaceIntensityXDirection IntensityXDirection` +IntensityXDirectionReverse | boolean attribute | `bool IntensityXDirectionReverse` +IntensityYDirection | Link attribute | `SpeosSim.SourceSurface.SourceSurfaceIntensityYDirection IntensityYDirection` +IntensityYDirectionReverse | boolean attribute | `bool IntensityYDirectionReverse` +SpectrumType | Enum attribute | `SpeosSim.SourceSurface.EnumSpectrumType SpectrumType` +SpectrumTypeIndex | Enum attribute (as index) | `int SpectrumTypeIndex` +SpectrumValueWavelength | Number attribute | `double SpectrumValueWavelength` +SpectrumValueWavelengthText | Number attribute (as text) | `string SpectrumValueWavelengthText` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +SpectrumValueLibrary | File attribute | `string SpectrumValueLibrary` +SpectrumValueLibraryFullPath | File attribute (absolute full path) | `string SpectrumValueLibraryFullPath` +ExitGeometry | Links attribute | `SpeosSim.SourceSurface.SourceSurfaceExitGeometry ExitGeometry` +FluxVariationPath | File attribute | `Fou.Utils.ValueObjects.FilePath FluxVariationPath` +FluxVariationPathFullPath | File attribute (absolute full path) | `string FluxVariationPathFullPath` +RelativeLag | Number attribute | `double RelativeLag` +RelativeLagText | Number attribute (as text) | `string RelativeLagText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceSurface.SourceSurfaceEmissiveFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.OrientedFace childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.OrientedFace Item` + +### SourceSurface.SourceSurfaceExitanceOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceSurface.SourceSurfaceExitanceXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceSurface.SourceSurfaceExitanceYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceSurface.SourceSurfaceIntensityXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceSurface.SourceSurfaceIntensityYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceSurface.SourceSurfaceExitGeometry + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## SourceThermic + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.SourceThermic Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.SourceThermic Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.SourceThermic Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.SourceThermic Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.SourceThermic CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +NbRays | Number attribute | `uint NbRays` +NbRaysText | Number attribute (as text) | `string NbRaysText` +RayLength | Number attribute | `double RayLength` +RayLengthText | Number attribute (as text) | `string RayLengthText` +DisplayModeType | Enum attribute | `SpeosSim.SourceThermic.EnumDisplayModeType DisplayModeType` +DisplayModeTypeIndex | Enum attribute (as index) | `int DisplayModeTypeIndex` +FluxType | Enum attribute | `SpeosSim.SourceThermic.EnumFluxType FluxType` +FluxTypeIndex | Enum attribute (as index) | `int FluxTypeIndex` +FluxValueLuminous | Number attribute | `double FluxValueLuminous` +FluxValueLuminousText | Number attribute (as text) | `string FluxValueLuminousText` +FluxValueRadiant | Number attribute | `double FluxValueRadiant` +FluxValueRadiantText | Number attribute (as text) | `string FluxValueRadiantText` +EmittanceType | Enum attribute | `SpeosSim.SourceThermic.EnumEmittanceType EmittanceType` +EmittanceTypeIndex | Enum attribute (as index) | `int EmittanceTypeIndex` +EmissiveFaces | Children attribute | `SpeosSim.SourceThermic.SourceThermicEmissiveFaces EmissiveFaces` +SpectrumValueTemperature | Number attribute | `double SpectrumValueTemperature` +SpectrumValueTemperatureText | Number attribute (as text) | `string SpectrumValueTemperatureText` +TemperatureFieldFile | File attribute | `string TemperatureFieldFile` +TemperatureFieldFileFullPath | File attribute (absolute full path) | `string TemperatureFieldFileFullPath` +OriginPoint | Link attribute | `SpeosSim.SourceThermic.SourceThermicOriginPoint OriginPoint` +XDirection | Link attribute | `SpeosSim.SourceThermic.SourceThermicXDirection XDirection` +XDirectionReverse | boolean attribute | `bool XDirectionReverse` +YDirection | Link attribute | `SpeosSim.SourceThermic.SourceThermicYDirection YDirection` +YDirectionReverse | boolean attribute | `bool YDirectionReverse` +OpticalPropertiesType | Enum attribute | `SpeosSim.SourceThermic.EnumOpticalPropertiesType OpticalPropertiesType` +OpticalPropertiesTypeIndex | Enum attribute (as index) | `int OpticalPropertiesTypeIndex` +Reflectance | Number attribute | `double Reflectance` +ReflectanceText | Number attribute (as text) | `string ReflectanceText` +SOPLibrary | File attribute | `string SOPLibrary` +SOPLibraryFullPath | File attribute (absolute full path) | `string SOPLibraryFullPath` +SopPluginPath | File attribute | `string SopPluginPath` +SopPluginPathFullPath | File attribute (absolute full path) | `string SopPluginPathFullPath` +SopPluginConfigurationPath | File attribute | `string SopPluginConfigurationPath` +SopPluginConfigurationPathFullPath | File attribute (absolute full path) | `string SopPluginConfigurationPathFullPath` +IntensityType | Enum attribute | `SpeosSim.SourceThermic.EnumIntensityType IntensityType` +IntensityTypeIndex | Enum attribute (as index) | `int IntensityTypeIndex` +IntensityN | Number attribute | `double IntensityN` +IntensityNText | Number attribute (as text) | `string IntensityNText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### SourceThermic.SourceThermicEmissiveFaces + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +Add | Children attribute: Add an object to the children list | `void Add(SpeosSim.OrientedFace childObject)` +Delete | Children attribute: Delete a child object by index | `bool Delete(int index)` +Clear | Children attribute: Empty the list | `void Clear()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.OrientedFace Item` + +### SourceThermic.SourceThermicOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceThermic.SourceThermicXDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### SourceThermic.SourceThermicYDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## SurfaceLayer + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.SurfaceLayer Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +SOPType | Enum attribute | `SpeosSim.SurfaceLayer.EnumSOPType SOPType` +SOPTypeIndex | Enum attribute (as index) | `int SOPTypeIndex` +SOPReflectance | Number attribute | `double SOPReflectance` +SOPReflectanceText | Number attribute (as text) | `string SOPReflectanceText` +SOPLibrary | File attribute | `string SOPLibrary` +SopAppearancePath | File attribute | `Fou.Utils.ValueObjects.FilePath SopAppearancePath` +AnisotropicTextureLayer | Number attribute | `uint AnisotropicTextureLayer` +AnisotropicTextureLayerText | Number attribute (as text) | `string AnisotropicTextureLayerText` +SopPluginPath | File attribute | `string SopPluginPath` +SopPluginConfigurationPath | File attribute | `string SopPluginConfigurationPath` +PreviewedLayer | Enum attribute | `SpeosSim.SurfaceLayer.EnumPreviewedLayer PreviewedLayer` +PreviewedLayerIndex | Enum attribute (as index) | `int PreviewedLayerIndex` +ImageTextureType | Enum attribute | `SpeosSim.SurfaceLayer.EnumImageTextureType ImageTextureType` +ImageTextureTypeIndex | Enum attribute (as index) | `int ImageTextureTypeIndex` +ImageTextureFilePath | File attribute | `string ImageTextureFilePath` +ImageTextureWidth | Number attribute | `double ImageTextureWidth` +ImageTextureWidthText | Number attribute (as text) | `string ImageTextureWidthText` +ImageTextureLayer | Number attribute | `uint ImageTextureLayer` +ImageTextureLayerText | Number attribute (as text) | `string ImageTextureLayerText` +NormalMapType | Enum attribute | `SpeosSim.SurfaceLayer.EnumNormalMapType NormalMapType` +NormalMapTypeIndex | Enum attribute (as index) | `int NormalMapTypeIndex` +NormalMapTextureFilePath | File attribute | `string NormalMapTextureFilePath` +NormalMapRoughness | Number attribute | `double NormalMapRoughness` +NormalMapRoughnessText | Number attribute (as text) | `string NormalMapRoughnessText` +NormalMapTextureWidth | Number attribute | `double NormalMapTextureWidth` +NormalMapTextureWidthText | Number attribute (as text) | `string NormalMapTextureWidthText` +NormalMapLayer | Number attribute | `uint NormalMapLayer` +NormalMapLayerText | Number attribute (as text) | `string NormalMapLayerText` + +## Surfaces + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +SurfaceType | Enum attribute | `SpeosSim.Surfaces.EnumSurfaceType SurfaceType` +SurfaceTypeIndex | Enum attribute (as index) | `int SurfaceTypeIndex` +SurfaceOpticalProperties | Children attribute | `SpeosSim.Sop SurfaceOpticalProperties` +Radius | Number attribute | `double Radius` +RadiusText | Number attribute (as text) | `string RadiusText` +RadiusX | Number attribute | `double RadiusX` +RadiusXText | Number attribute (as text) | `string RadiusXText` +ConicX | Number attribute | `double ConicX` +ConicXText | Number attribute (as text) | `string ConicXText` +RadiusY | Number attribute | `double RadiusY` +RadiusYText | Number attribute (as text) | `string RadiusYText` +ConicY | Number attribute | `double ConicY` +ConicYText | Number attribute (as text) | `string ConicYText` +Clear | Number attribute | `double Clear` +ClearText | Number attribute (as text) | `string ClearText` +Edge | Number attribute | `double Edge` +EdgeText | Number attribute (as text) | `string EdgeText` +Conic | Number attribute | `double Conic` +ConicText | Number attribute (as text) | `string ConicText` +Offset | Number attribute | `double Offset` +OffsetText | Number attribute (as text) | `string OffsetText` +ModelType | string attribute | `string ModelType` +AsphericCoefficientsX | Children attribute | `SpeosSim.Surfaces.SurfacesAsphericCoefficientsX AsphericCoefficientsX` +AsphericCoefficientsY | Children attribute | `SpeosSim.Surfaces.SurfacesAsphericCoefficientsY AsphericCoefficientsY` +BiconicDecenterX | Number attribute | `double BiconicDecenterX` +BiconicDecenterXText | Number attribute (as text) | `string BiconicDecenterXText` +BiconicDecenterY | Number attribute | `double BiconicDecenterY` +BiconicDecenterYText | Number attribute (as text) | `string BiconicDecenterYText` +NormRadius | Number attribute | `double NormRadius` +NormRadiusText | Number attribute (as text) | `string NormRadiusText` +Coefficients | Children attribute | `SpeosSim.Surfaces.SurfacesCoefficients Coefficients` +AsphericCoefficients | Children attribute | `SpeosSim.Surfaces.SurfacesAsphericCoefficients AsphericCoefficients` +PolynomialCoefficients | Children attribute | `SpeosSim.Surfaces.SurfacesPolynomialCoefficients PolynomialCoefficients` +Extrapolate | boolean attribute | `bool Extrapolate` +ZernikeType | Enum attribute | `SpeosSim.Surfaces.EnumZernikeType ZernikeType` +ZernikeTypeIndex | Enum attribute (as index) | `int ZernikeTypeIndex` +ZernikeTerms | Children attribute | `SpeosSim.Surfaces.SurfacesZernikeTerms ZernikeTerms` +ZernikeDecenterX | Number attribute | `double ZernikeDecenterX` +ZernikeDecenterXText | Number attribute (as text) | `string ZernikeDecenterXText` +ZernikeDecenterY | Number attribute | `double ZernikeDecenterY` +ZernikeDecenterYText | Number attribute (as text) | `string ZernikeDecenterYText` +DecenterX | Number attribute | `double DecenterX` +DecenterXText | Number attribute (as text) | `string DecenterXText` +DecenterY | Number attribute | `double DecenterY` +DecenterYText | Number attribute (as text) | `string DecenterYText` +Body | Links attribute | `SpeosSim.Surfaces.SurfacesBody Body` +FrontFaces | Links attribute | `SpeosSim.Surfaces.SurfacesFrontFaces FrontFaces` +BackFaces | Links attribute | `SpeosSim.Surfaces.SurfacesBackFaces BackFaces` +EdgeFaces | Links attribute | `SpeosSim.Surfaces.SurfacesEdgeFaces EdgeFaces` +NewFaces | Links attribute | `SpeosSim.Surfaces.SurfacesNewFaces NewFaces` + +### Surfaces.SurfacesAsphericCoefficientsX + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` + +### Surfaces.SurfacesAsphericCoefficientsY + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` + +### Surfaces.SurfacesCoefficients + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` + +### Surfaces.SurfacesAsphericCoefficients + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` + +### Surfaces.SurfacesPolynomialCoefficients + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` + +### Surfaces.SurfacesZernikeTerms + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Children attribute: Set from an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Children attribute: Set from an array of objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +GetEnumerator | Children attribute: Get children enumeration | `IEnumerator GetEnumerator()` +SelectAll | Children attribute: Create children for all objects that are compatible with link selection. | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Children attribute: Get linked objects | `IReadOnlyCollection LinkedObjects` +Count | Children attribute: Get children count | `int Count` +List | Children attribute: Get children collection | `IReadOnlyCollection List` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` +Item | Children attribute: Get child by index | `SpeosSim.Coefficient Item` + +### Surfaces.SurfacesBody + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Surfaces.SurfacesFrontFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Surfaces.SurfacesBackFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Surfaces.SurfacesEdgeFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### Surfaces.SurfacesNewFaces + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +## UVMap + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.UVMap Find(string objectName)` + +### Method + +Name | Description | Syntax +--- | --- | --- +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Comment | string attribute | `string Comment` +Index | Number attribute | `uint Index` +IndexText | Number attribute (as text) | `string IndexText` +OriginPoint | Link attribute | `SpeosSim.UVMap.UVMapOriginPoint OriginPoint` +ProjectionDirection | Link attribute | `SpeosSim.UVMap.UVMapProjectionDirection ProjectionDirection` +ProjectionDirectionReverse | boolean attribute | `bool ProjectionDirectionReverse` +OrientationDirection | Link attribute | `SpeosSim.UVMap.UVMapOrientationDirection OrientationDirection` +OrientationDirectionReverse | boolean attribute | `bool OrientationDirectionReverse` +MappingType | Enum attribute | `SpeosSim.UVMap.EnumMappingType MappingType` +MappingTypeIndex | Enum attribute (as index) | `int MappingTypeIndex` +UOffset | Number attribute | `double UOffset` +UOffsetText | Number attribute (as text) | `string UOffsetText` +UScale | Number attribute | `double UScale` +UScaleText | Number attribute (as text) | `string UScaleText` +URepeat | boolean attribute | `bool URepeat` +VOffset | Number attribute | `double VOffset` +VOffsetText | Number attribute (as text) | `string VOffsetText` +VScale | Number attribute | `double VScale` +VScaleText | Number attribute (as text) | `string VScaleText` +VRepeat | boolean attribute | `bool VRepeat` +Rotate | Number attribute | `double Rotate` +RotateText | Number attribute (as text) | `string RotateText` +Perimeter | Number attribute | `double Perimeter` +PerimeterText | Number attribute (as text) | `string PerimeterText` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### UVMap.UVMapOriginPoint + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### UVMap.UVMapProjectionDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +### UVMap.UVMapOrientationDirection + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Link attribute: Set the link to a script object | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)` +Set | Link attribute: Set the link to a DocObject | `bool Set(SpaceClaim.Api.V251.IDocObject selectedObject)` +Set | Link attribute: Set the link to an object (IDocObject type from unspecified version) | `bool Set(object docObjectFromPreviousVersion)` +Clear | Link attribute: Clear the link | `void Clear()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObject | Link attribute: Get the pointed object | `SpaceClaim.Api.V251.IDocObject LinkedObject` + +## UVMapping + +### Static method + +Name | Description | Syntax +--- | --- | --- +FromSelection | Convert Items of a ScriptSelection to a list of Speos objects when their type is matching. | `IEnumerable FromSelection(IEnumerable selectionItems)` +Find | Returns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.*") | `SpeosSim.UVMapping Find(string objectName)` +Create | Create a new object of this type under the specified parent component | `SpeosSim.UVMapping Create(object parent)` +Create | Create a new object in the active context | `SpeosSim.UVMapping Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +Clone | Create a copy of this object in the active context | `SpeosSim.UVMapping Clone()` +CopyTo | Create a copy of this object and paste it to the specified destination | `SpeosSim.UVMapping CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)` +AddUvMap | Add an UV Map layer object | `SpeosSim.UVMap AddUvMap()` +FindOccurrenceInActivePart | Search for occurrences of this object in the active Part | `object FindOccurrenceInActivePart()` +FindOccurrenceInContextOf | Search for occurrences of this object in the specified Part | `SpaceClaim.Api.V251.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V251.IDocObject contextObject)` +ToString | Get a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable) | `string ToString()` +Delete | Delete this object | `bool Delete()` +GetChildSubjects | Retrieve all children as DocObjects | `IEnumerable GetChildSubjects()` +GetChildren | Retrieve all direct children of a given type | `IEnumerable GetChildren()` +Compute | Execute the Compute command on the object | `void Compute()` +PublishParameter | Publish or un-publish a number attribute as driving parameter | `void PublishParameter(string fieldName, bool trueToPublish)` +PublishAllParametersToWorkbench | Call this method to expose all object's attributes so that they can be accessible and driven from Workbench. | `void PublishAllParametersToWorkbench(bool trueToPublish)` +ApplyPreset | Update the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `void ApplyPreset(string presetFilePath)` +ExportToPreset | Export the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method reports an error. | `string ExportToPreset(string filePath)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Description | string attribute | `string Description` +Geometries | Links attribute | `SpeosSim.UVMapping.UVMappingGeometries Geometries` +Layers | Children CustomObjects attribute | `SpeosSim.UVMapping.UVMappingLayers Layers` +Subject | Deprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper | `SpaceClaim.Api.V251.CustomObject Subject` +Occurrence | Get the underlying CustomObject occurrence, associated to the API object wrapper in current API version | `object Occurrence` +Name | Get or Set the name of the object | `string Name` +Visible | Change the visibility status (same behavior as checking/unchecking on the tree view item) | `bool Visible` +StatusInfo | Get the status of the object (warning or error message) | `string StatusInfo` +IsUpToDate | Ask if the object was modified since its last successful computation | `bool IsUpToDate` + +### UVMapping.UVMappingGeometries + +### Method + +Name | Description | Syntax +--- | --- | --- +Set | Links attribute: Link to an array of script objects | `bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects | `bool Set(SpaceClaim.Api.V251.IDocObject[] selectedObjects)` +Set | Links attribute: Link to an array of document objects (IDocObject type from unspecified version) | `bool Set(System.Object[] docObjectsFromPreviousVersion)` +Clear | Links attribute: Clear the list of links | `void Clear()` +SelectAll | Links attribute: Link to all compatible objects in the active context | `void SelectAll()` + +### Property + +Name | Description | Syntax +--- | --- | --- +LinkedObjects | Links attribute: Get the pointed document objects | `IReadOnlyCollection LinkedObjects` +Item | Links attribute: Get a pointed document object by index | `SpaceClaim.Api.V251.IDocObject Item` +Count | Links attribute: Get the links count | `int Count` + +### UVMapping.UVMappingLayers + +### Method + +Name | Description | Syntax +--- | --- | --- +GetEnumerator | Get children CustomObjects enumeration | `IEnumerator GetEnumerator()` +AddNew | Create a new child CustomObject | `SpeosSim.UVMap AddNew(int insertIndex)` +Delete | Delete a child CustomObject by index | `void Delete(int index)` + +### Property + +Name | Description | Syntax +--- | --- | --- +Count | Get children CustomObjects count | `int Count` +List | Get children CustomObjects list | `IReadOnlyCollection List` +Item | Get child CustomObject by index | `SpeosSim.UVMap Item` +Item | Get child CustomObject by index | `SpeosSim.UVMap Item` + +## Vop + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | Create a new object of this type | `SpeosSim.Vop Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +ToString | | `string ToString()` + +### Property + +Name | Description | Syntax +--- | --- | --- +TypeOpaque | String attribute | `string TypeOpaque` +CatalogName | string attribute | `string CatalogName` +GlassName | string attribute | `string GlassName` +WavelengthMin | Number attribute | `double WavelengthMin` +WavelengthMinText | Number attribute (as text) | `string WavelengthMinText` +WavelengthMax | Number attribute | `double WavelengthMax` +WavelengthMaxText | Number attribute (as text) | `string WavelengthMaxText` + +## SpeosOptionsConfiguration + +### Property + +Name | Description | Syntax +--- | --- | --- +PrecisionLength | | `int PrecisionLength` +PrecisionAngle | | `int PrecisionAngle` +PrecisionOther | | `int PrecisionOther` +ResultsAutomaticLaunchWhenSimulationEnds | | `bool ResultsAutomaticLaunchWhenSimulationEnds` +ResultsDraw | | `bool ResultsDraw` +ResultsDrawNullValuesAsTransparent | | `bool ResultsDrawNullValuesAsTransparent` +ActivateImageMeshing | | `bool ActivateImageMeshing` +LineColorPreviewMeshing | | `System.Drawing.Color LineColorPreviewMeshing` +CustomColorsForPicker | | `System.Int32[] CustomColorsForPicker` +ResultsSoundWhenSimulationEnds | | `bool ResultsSoundWhenSimulationEnds` +SimulationNumberOfThreads | | `int SimulationNumberOfThreads` +SimulationVRSensorMemoryManagement | | `bool SimulationVRSensorMemoryManagement` +Colorimetry | | `Dom.Optics.ColorimetryStandard Colorimetry` +IntensityResultViewingDirection | | `Dom.Optics.PropagationDirection IntensityResultViewingDirection` +CopySelectedInputFilesUnderDocumentFolder | | `bool CopySelectedInputFilesUnderDocumentFolder` +PresetsCustomFolder | | `string PresetsCustomFolder` +NoInteropHealing | | `bool NoInteropHealing` + +## Options + +### Static method + +Name | Description | Syntax +--- | --- | --- +Get | Get an object that reflects the state of the Speos General options. Value changes on this object will affect the application options only when it is set back. | `App.ObjectModel.SpeosOptionsConfiguration Get()` +Set | Request a change on the Speos General options to match the provided object state. | `void Set(App.ObjectModel.SpeosOptionsConfiguration options)` +Reset | Set the Speos General options back to their default values. | `void Reset()` + +## InverseSimulationSettings + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | | `SpeosSim.InverseSimulationSettings Create()` + +### Method + +Name | Description | Syntax +--- | --- | --- +SetDeterminist | | `void SetDeterminist(SpeosSim.InverseSimulationSettings.EnumPhotonMapMode photonMapMode, int ambientSampling, int maxNbSurfaceInteractions, bool antiAliasing, int specularApproxAngle)` +SetDeterministPhotonMap | | `void SetDeterministPhotonMap(int maxNeighbors, int maxSearchRadius, bool fastTransmissionGathering, bool useFinalGathering, int finalGatheringMaxNeighbors, int finalGatheringSplittingNb)` +SetDeterministPhotonMapBuild | | `void SetDeterministPhotonMapBuild(int nbPhotonsInDirectPhase, int nbSurfaceInteractionsInDirectPhase)` +SetPropagationErrorAnalysis | | `void SetPropagationErrorAnalysis(bool propagationErrorAnalysis)` +SetMonteCarlo | | `void SetMonteCarlo(bool dispersion, bool splitting, int nbGatheringRaysPerSource, int maxGatheringError, bool fastTransmissionGathering, int automaticSaveFrequencySeconds, SpeosSim.InverseSimulationSettings.EnumOptimizedPropagationMode optimizedPropagation, int nbStandardPassesBeforeOptimizedPasses)` + +### Property + +Name | Description | Syntax +--- | --- | --- +UseRenderingPropertiesAsOpticalProperties | | `bool UseRenderingPropertiesAsOpticalProperties` +UseMonteCarloAlgorithm | | `bool UseMonteCarloAlgorithm` +UseFastTransmissionGathering | | `bool UseFastTransmissionGathering` +PropagationErrorAnalysis | | `bool PropagationErrorAnalysis` +MonteCarloOptimizedPropagationMode | | `SpeosSim.InverseSimulationSettings.EnumOptimizedPropagationMode MonteCarloOptimizedPropagationMode` +MonteCarloOptimizedPropagationNbStandardPasses | | `int MonteCarloOptimizedPropagationNbStandardPasses` +MonteCarloPropagationDispersion | | `bool MonteCarloPropagationDispersion` +MonteCarloPropagationSplitting | | `bool MonteCarloPropagationSplitting` +MonteCarloPropagationNbGatheringRaysPerSource | | `int MonteCarloPropagationNbGatheringRaysPerSource` +MonteCarloPropagationMaxGatheringErrors | | `int MonteCarloPropagationMaxGatheringErrors` +MonteCarloAutomaticSaveFrequencySeconds | | `int MonteCarloAutomaticSaveFrequencySeconds` +DeterministPhotonMapMode | | `SpeosSim.InverseSimulationSettings.EnumPhotonMapMode DeterministPhotonMapMode` +DeterministAmbientSampling | | `int DeterministAmbientSampling` +DeterministMaxNbSurfaceInteractions | | `int DeterministMaxNbSurfaceInteractions` +DeterministAntiAliasing | | `bool DeterministAntiAliasing` +DeterministSpecularApproxAngle | | `double DeterministSpecularApproxAngle` +DeterministPhotonMapMaxNeighbors | | `int DeterministPhotonMapMaxNeighbors` +DeterministPhotonMapMaxSearchRadius | | `int DeterministPhotonMapMaxSearchRadius` +DeterministPhotonMapUseFinalGathering | | `bool DeterministPhotonMapUseFinalGathering` +DeterministPhotonMapFinalGatheringMaxNeighbors | | `int DeterministPhotonMapFinalGatheringMaxNeighbors` +DeterministPhotonMapFinalGatheringSplittingNb | | `int DeterministPhotonMapFinalGatheringSplittingNb` +DeterministPhotonMapBuildNbPhotonsInDirectPhase | | `int DeterministPhotonMapBuildNbPhotonsInDirectPhase` +DeterministPhotonMapBuildMaxNbSurfaceInteractionsInDirectPhase | | `int DeterministPhotonMapBuildMaxNbSurfaceInteractionsInDirectPhase` + +## SimulationSettings + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | | `SpeosSim.SimulationSettings Create()` + +### Property + +Name | Description | Syntax +--- | --- | --- +Texture | | `bool Texture` +TextureNormalization | | `SpeosSim.SimulationSettings.EnumTextureNormalizationType TextureNormalization` +TextureBump | | `bool TextureBump` +MeshingSagMode | | `SpeosSim.SimulationSettings.EnumMeshingSagMode MeshingSagMode` +MeshingSagValue | | `double MeshingSagValue` +MeshingStepMode | | `SpeosSim.SimulationSettings.EnumMeshingStepMode MeshingStepMode` +MeshingStepValue | | `double MeshingStepValue` +MeshingAngle | | `double MeshingAngle` +GeometricalDistanceTolerance | | `double GeometricalDistanceTolerance` +MaxNumberInteractions | | `int MaxNumberInteractions` +RayTracerPrecision | | `SpeosSim.SimulationSettings.EnumRayTracer RayTracerPrecision` +Weight | | `bool Weight` +MinimumEnergyPercentage | | `double MinimumEnergyPercentage` +ColorimetricStandard | | `SpeosSim.SimulationSettings.EnumColorimetricStandard ColorimetricStandard` +SmartEngine | | `int SmartEngine` + +## DirectSimulationSettings + +### Static method + +Name | Description | Syntax +--- | --- | --- +Create | | `SpeosSim.Specific.DirectSimulationSettings Create()` +GetFromWrapper | | `SpeosSim.Specific.DirectSimulationSettings GetFromWrapper(App.ObjectModel.Interfaces.IHasSpeosSettings simulationSettings)` +SetToWrapper | | `void SetToWrapper(App.ObjectModel.Interfaces.IHasSpeosSettings simulationSettings, SpeosSim.Specific.DirectSimulationSettings directSimulationSettings)` + +### Method + +Name | Description | Syntax +--- | --- | --- +SetFastTransmissionGathering | | `void SetFastTransmissionGathering(bool fastTransmissionGathering)` +SetPropagationErrorAnalysis | | `void SetPropagationErrorAnalysis(bool propagationErrorAnalysis)` +SetDispersion | | `void SetDispersion(bool dispersion)` +SetAutomaticSaveFrequency | | `void SetAutomaticSaveFrequency(int directTemporarySave)` + +### Property + +Name | Description | Syntax +--- | --- | --- +UseFastTransmissionGathering | | `bool UseFastTransmissionGathering` +PropagationErrorAnalysis | | `bool PropagationErrorAnalysis` +Dispersion | | `bool Dispersion` +AutomaticSaveFrequencySeconds | | `int AutomaticSaveFrequencySeconds` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/resultlxp_getmeasurevalue_list_enum.md b/2025R1_Test/speos/articles/sim/resultlxp_getmeasurevalue_list_enum.md new file mode 100644 index 0000000000..03389a7364 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/resultlxp_getmeasurevalue_list_enum.md @@ -0,0 +1,37 @@ +# GetMeasureValues method - list of possible values + +The following page list you the possible values that can be inputted in the **GetMeasureValues** method of **ResultLXP**. + +|Type|Measure Value| +|----|-------------| +|OptisMapMeasureTypeUnknown|0| +|OptisMapMeasureTypeMax|1| +|OptisMapMeasureTypeMax_X|2| +|OptisMapMeasureTypeMax_Y|3| +|OptisMapMeasureTypeMin|4| +|OptisMapMeasureTypeMin_X|5| +|OptisMapMeasureTypeMin_Y|6| +|OptisMapMeasureTypeAverage|7| +|OptisMapMeasureTypeFlux|8| +|OptisMapMeasureTypeBarycentreX|9| +|OptisMapMeasureTypeBarycentreY|10| +|OptisMapMeasureTypeSigma|11| +|OptisMapMeasureTypeSigmaX|12| +|OptisMapMeasureTypeSigmaY|13| +|OptisMapMeasureTypeContrast|14| +|OptisMapMeasureTypeRMSContrast|15| +|OptisMapMeasureTypeEyeIrradiance|16| +|OptisMapMeasureTypeRange|17| +|OptisMapMeasureTypeNone|18| +|OptisMapMeasureTypeRange_X|19| +|OptisMapMeasureTypeRange_Y|20| +|OptisMapMeasureTypeArea|21| +|OptisMapMeasureTypeUGR117|22| +|OptisMapMeasureTypeMax_Z|23| +|OptisMapMeasureTypeMin_Z|24| +|OptisMapMeasureTypeBarycentreZ|25| +|OptisMapMeasureTypeSigmaZ|26| +|OptisMapMeasureTypeRange_Z|27| +|OptisMapMeasureTypeDeviationMin|28| +|OptisMapMeasureTypeDeviationMax|29| +|OptisMapMeasureTypeDeviationAverage|30| diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_component3dtexture_creating_3d_texture_on_geometry.md b/2025R1_Test/speos/articles/sim/sim-example/method_component3dtexture_creating_3d_texture_on_geometry.md new file mode 100644 index 0000000000..bc74903bd7 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_component3dtexture_creating_3d_texture_on_geometry.md @@ -0,0 +1,24 @@ +# Component3Dtexture – Creating a 3D texture on a geometry + +The following script sample shows you an example on how to create a 3D Texture. + +```ironpython +texture3D = SpeosSim.Component3DTexture.Create() +texture3D.Name = "Created 3D texture" + +texture3D.OriginPoint.Set(GetRootPart().Curves[0]) +texture3D.XDirection.Set(GetRootPart().Curves[1]) +texture3D.YDirection.Set(GetRootPart().Curves[2]) + +texture3D.SupportGeometry.Set(geo) + +texture3D.PatternFile = SpeosSim.Command.GetInputFolder() + "PRISM.scdoc" +texture3D.PatternGlobalScale = 0.4 +texture3D.PreviewSizeX = 100 +texture3D.PreviewSizeY = 100 +texture3D.PreviewSizeZ = 100 + +texture3D.MappingType = SpeosSim.Component3DTexture.EnumMappingType.Rectangular + +texture3D.Compute() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_componentexport_creating_lightbox_export.md b/2025R1_Test/speos/articles/sim/sim-example/method_componentexport_creating_lightbox_export.md new file mode 100644 index 0000000000..b6472ed86e --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_componentexport_creating_lightbox_export.md @@ -0,0 +1,21 @@ +# ComponentExport – Creating a lightBox export + +The following script sample shows you an example on how to create a Light Box Export. + +```ironpython +lightBoxExport = SpeosSim.ComponentExport.Create() +lightBoxExport.Name = "Created component export" + +lightBoxExport.OriginPoint.Set(GetRootPart().Curves[0]) +lightBoxExport.XDirection.Set(GetRootPart().Curves[1]) +lightBoxExport.YDirection.Set(GetRootPart().Curves[2]) + +surfaceSource = SpeosSim.SourceSurface.Find("Surface.1") +lightBoxExport.Sources.Set(surfaceSource) +lightBoxExport.Geometries.Set(GetRootPart().Bodies[0]) + + +lightBoxExport.Compute() + +lightBoxExportPath = lightBoxExport.GetResultFilePath() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_componentimport_creating_lightbox_import.md b/2025R1_Test/speos/articles/sim/sim-example/method_componentimport_creating_lightbox_import.md new file mode 100644 index 0000000000..c1cf033a05 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_componentimport_creating_lightbox_import.md @@ -0,0 +1,15 @@ +# ComponentImport – Creating a lightBox import + +The following script sample shows you an example on how to create a Light Box Import. + +```ironpython +lightBoxImport = SpeosSim.ComponentImport.Create() +lightBoxImport.Name = "Created component import" + +lightBoxImport.OriginPoint.Set(GetRootPart().Curves[0]) +lightBoxImport.XDirection.Set(GetRootPart().Curves[1]) +lightBoxImport.YDirection.Set(GetRootPart().Curves[2]) +lightBoxImport.ImportFile = lightBoxExportPath + +lightBoxImport.Compute() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_directsimulationsettings_setting_direct_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_directsimulationsettings_setting_direct_simulation.md new file mode 100644 index 0000000000..30d83236c6 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_directsimulationsettings_setting_direct_simulation.md @@ -0,0 +1,22 @@ +# DirectSImulationSettings – Setting a direct simulation + +The following script sample shows you an example on how to set a Direct Simulation. + +**GetDirectSimulationSettings** returns a **DirectSimulationSettings** object that allows you to modify simulation settings. + +The **DirectSimulationSettings** object includes four main methods: + - SetPropagationErrorAnalysis\(*bool propagationErrorAnalysis*\) + - SetDispersion\(*bool dispersion*\) + - SetFastTransmissionGathering\(*bool fastTransmissionGathering*\) + - SetAutomaticSaveFrequency\(*int directTemporarySave*\) + +**SetDirectSimulationSettings** applies the changes made with the **GetDirectSimulationSettings** function. + +```ironpython +directSetting = simuDir.GetDirectSimulationSettings() +directSetting.SetPropagationErrorAnalysis(False) +directSetting.SetDispersion(True) +directSetting.SetFastTransmissionGathering(False) +directSetting.SetAutomaticSaveFrequency(1800) +simuDir.SetDirectSimulationSettings(directSetting) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_eyeboxconfiguration_defining_hoa_multieyebox.md b/2025R1_Test/speos/articles/sim/sim-example/method_eyeboxconfiguration_defining_hoa_multieyebox.md new file mode 100644 index 0000000000..4e9e045ff7 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_eyeboxconfiguration_defining_hoa_multieyebox.md @@ -0,0 +1,22 @@ +# EyeboxConfiguration – Defining a HUD optical analysis with multi-eyebox configuration + +This page presents you an example on how to define a Head-Up Display Optical Analysis with a multi-eyebox configuration using the **TiltAngle** method. + +```ironpython +multiEyeBoxMirrors = hoaSimulation.Mirrors.GetMultiEyeBoxMirrorPossibleValues() + +for multiEyeBoxMirror in multiEyeBoxMirrors: + if multiEyeBoxMirror.Contains(GetRootPart().Bodies[1].GetName()): + hoaSimulation.Mirrors.MultiEyeBoxMirror = multiEyeBoxMirror + break + +hoaSimulation.Mirrors.TiltRotationAxis.Set(GetRootPart().Curves[1]) + +ebConfigurations = hoaSimulation.Mirrors.EBMirrorConfigurations + +for ebConfig in ebConfigurations: + if ebConfig.EBConfigName.Contains("Lower"): + ebConfig.TiltAngle = -2 + elif ebConfig.EBConfigName.Contains("Upper"): + ebConfig.TiltAngle = 2 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_ftgenabledgeometry_activating_ftg_on_geometry.md b/2025R1_Test/speos/articles/sim/sim-example/method_ftgenabledgeometry_activating_ftg_on_geometry.md new file mode 100644 index 0000000000..16f7d6da1f --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_ftgenabledgeometry_activating_ftg_on_geometry.md @@ -0,0 +1,15 @@ +# FTGEnabledGeometry – Activating the fast transmission gathering on a geometry + +The following script sample shows you an example on how to activate the Fast Transmission Gathering on a geometry. + +This action is done handling **FTGEnabledGeometry** object: + +```ironpython +ftgGeometry = SpeosSim.FTGEnabledGeometry.Create() +ftgGeometry.FTGGeometry.Set(GetRootPart().Bodies[0]) +ftgGeometry.IsFTG = True + +directSimulation = SpeosSim.SimulationDirect.Create() +directSimulation.SetDirectSimulationSettings(True, True, 1800 ) +directSimulation.Geometries.Add(ftgGeometry) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_inversesimulationsettings_setting_inverse_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_inversesimulationsettings_setting_inverse_simulation.md new file mode 100644 index 0000000000..5fe9b1e48a --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_inversesimulationsettings_setting_inverse_simulation.md @@ -0,0 +1,46 @@ +# InverseSimulationSettings – Setting an inverse simulation + +The following script sample shows you an example on how to set an Inverse Simulation. + +**GetInverseSimulationSettings** returns an **InverseSimulationSettings** object that allows you to modify geometry and simulation settings. + +The **InverseSimulationSettings** object includes five main methods: + - **SetMonteCarlo** with the parameters + - bool dispersion + - bool splitting + - int nbGatheringRaysPerSource + - int maxGatheringError + - bool fastTransmissionGathering + - int automaticSaveFrequencySeconds + - EnumOptimizedPropagationMode + - optimizedPropagation + - int nbStandardPassesBeforeOptimizedPasses, optional + - **SetDeterminist** with the parameters: + - EnumPhotonMapMode + - photonMapMode + - int ambientSampling + - int maxNbSurfaceInteractions + - bool antiAliasing + - int specularApproxAngle + - **SetDeterministPhotonMap** with the parameters: + - int maxNeighbors + - int maxSearchRadius + - bool fastTransmissionGathering + - bool useFinalGathering + - int finalGatheringMaxNeighbors, optional + - int finalGatheringSplittingNb, optional + - **SetDeterministPhotonMapBuild** with the parameters: + - int nbPhotonsInDirectPhase + - int nbSurfaceInteractionsInDirectPhase + - **SetPropagationErrorAnalysis\(*bool propagationErrorAnalysis*\)** + +**SetInverseSimulationSettings** applies the changes made with the **GetInverseSimulationSettings** function. + +```ironpython +settings = inverseSimulation2.GetInverseSimulationSettings() +settings.SetDeterminist(SIM.InverseSimulationSettings.EnumPhotonMapMode.Load, 100, 10, False, 0) +settings.SetDeterministPhotonMapBuild(10000,100) +settings.SetDeterministPhotonMap(100, 10000000, True, False) +settings.SetPropagationErrorAnalysis(True) +inverseSimulation2.SetInverseSimulationSettings(settings) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_localmeshing_creating_local_meshing.md b/2025R1_Test/speos/articles/sim/sim-example/method_localmeshing_creating_local_meshing.md new file mode 100644 index 0000000000..021ca1fb9f --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_localmeshing_creating_local_meshing.md @@ -0,0 +1,13 @@ +# LocalMeshing – Creating a local meshing + +The following script sample shows you an example on how to create a Local Meshing. + +```ironpython +localMeshing = SpeosSim.LocalMeshing.Create() +localMeshing.Geometries.SelectAll() +localMeshing.MeshingSagMode = SpeosSim.LocalMeshing.EnumMeshingSagMode.Proportional +localMeshing.MeshingSagValue = 500000 + +localMeshing.MeshingStepMode = SpeosSim.LocalMeshing.EnumMeshingStepMode.Fixed +localMeshing.MeshingStepLengthValue = 1 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_lxpenabledsensor_activating_lxp_on_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_lxpenabledsensor_activating_lxp_on_sensor.md new file mode 100644 index 0000000000..448e8dd3b7 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_lxpenabledsensor_activating_lxp_on_sensor.md @@ -0,0 +1,13 @@ +# LXPEnabledSensor – Activating the light expert on a sensor + +When Light Expert is enabled in the definition of simulations, the LXP flag can be enabled on particular sensors. + +This action is done handling **LXPEnabledSensor** object: + +```ironpython +inverseSimulation = SIM.SimulationInverse.Create() +lxpSensor = SpeosSim.LXPEnabledSensor.Create() +lxpSensor.LXPSensor.Set(radianceSensor) +lxpSensor.IsLXP = True +inverseSimulation.Sensors.Add(lxpSensor) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_material_creating_applying_materials.md b/2025R1_Test/speos/articles/sim/sim-example/method_material_creating_applying_materials.md new file mode 100644 index 0000000000..f7fa6b5c9d --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_material_creating_applying_materials.md @@ -0,0 +1,27 @@ +# Material – Creating and applying materials + +The following script sample shows you an example on how to define VOP and SOP and apply them. + +```ironpython +newMaterial = SpeosSim.Material.Create() +newMaterial.Name = "New material" +newMaterial.OpticalPropertiesType = SpeosSim.Material.EnumOpticalPropertiesType.Volumic +newMaterial.VOPType = SpeosSim.Material.EnumVOPType.Optic +newMaterial.VOPIndex = 1.5 +newMaterial.VOPAbsorption = 0 +newMaterial.VOPConstringence = 0 +newMaterial.SOPType = SpeosSim.Material.EnumSOPType.OpticalPolished +newMaterial.VolumeGeometries.Set(GetRootPart().Bodies[0]) + +newSOP = SpeosSim.Material.Create() +newSOP.Name = "New surface optical property" +newSOP.OpticalPropertiesType = SpeosSim.Material.EnumOpticalPropertiesType.Surfacic +newSOP.SOPType = SpeosSim.Material.EnumSOPType.Library +newSOP.SOPLibrary = R".\SPEOS input files\Munsell07_Whitepaint.bsdf180" + +orientedFace = SpeosSim.OrientedFace.Create() +orientedFace.Face.Set(face) +orientedFace.ReverseDirection = True + +newSOP.OrientedFaces.Add(orientedFace) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_options_reseting_values.md b/2025R1_Test/speos/articles/sim/sim-example/method_options_reseting_values.md new file mode 100644 index 0000000000..358021e957 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_options_reseting_values.md @@ -0,0 +1,8 @@ +# Options – Reseting values + +The following script sample shows you an example on how to reset values. + +```ironpython +SpeosSim.Options.Reset() +optionsDefault = SpeosSim.Options.Get() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_options_retrieving_values.md b/2025R1_Test/speos/articles/sim/sim-example/method_options_retrieving_values.md new file mode 100644 index 0000000000..06c8cdab98 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_options_retrieving_values.md @@ -0,0 +1,22 @@ +# Options – Retrieving values + +The following script sample shows you an example on how to retrieve different values. + +```ironpython +options = SpeosSim.Options.Get() + +Colorimetry = options.Colorimetry +CopySelectedInputFilesUnderDocumentFolder = options.CopySelectedInputFilesUnderDocumentFolder +IntensityResultViewingDirection = options.IntensityResultViewingDirection +NoInteropHealing = options.NoInteropHealing +PrecisionAngle = options.PrecisionAngle +PrecisionLength = options.PrecisionLength +PrecisionOther = options.PrecisionOther +PresetsCustomFolder = options.PresetsCustomFolder +ResultsAutomaticLaunchWhenSimulationEnds = options.ResultsAutomaticLaunchWhenSimulationEnds +ResultsDraw = options.ResultsDraw +ResultsDrawNullValuesAsTransparent = options.ResultsDrawNullValuesAsTransparent +ResultsSoundWhenSimulationEnds = options.ResultsSoundWhenSimulationEnds +SimulationNumberOfThreads = options.SimulationNumberOfThreads +SimulationVRSensorMemoryManagement = options.SimulationVRSensorMemoryManagement +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_options_updating_values.md b/2025R1_Test/speos/articles/sim/sim-example/method_options_updating_values.md new file mode 100644 index 0000000000..c98035d7a7 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_options_updating_values.md @@ -0,0 +1,23 @@ +# Options – Updating values + +The following script sample shows you an example on how to update values. + +```ironpython +import Dom.Optics +options.Colorimetry = Dom.Optics.ColorimetryStandard.CIE1964 +options.CopySelectedInputFilesUnderDocumentFolder = False +options.IntensityResultViewingDirection = Dom.Optics.PropagationDirection.FromSensorLookingAtSource +options.NoInteropHealing = False +options.PrecisionAngle = 2 +options.PrecisionLength = 4 +options.PrecisionOther = 3 +options.PresetsCustomFolder = r"C:\Presets" +options.ResultsAutomaticLaunchWhenSimulationEnds = True +options.ResultsDraw = False +options.ResultsDrawNullValuesAsTransparent = True +options.ResultsSoundWhenSimulationEnds = True +options.SimulationNumberOfThreads = 1 +options.SimulationVRSensorMemoryManagement = False + +SpeosSim.Options.Set(options) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_resultlxp_analyzing_interactive_simulation_lxp_result.md b/2025R1_Test/speos/articles/sim/sim-example/method_resultlxp_analyzing_interactive_simulation_lxp_result.md new file mode 100644 index 0000000000..42d1e97a88 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_resultlxp_analyzing_interactive_simulation_lxp_result.md @@ -0,0 +1,21 @@ +# ResultLXP – Analyzing the interactive simulation light expert result + +The following script sample shows you an example on how to analyze an Interactive Simulation Light Expert result. + +```ironpython +interactiveSimulation = SpeosSim.SimulationInteractive.Create() +interactiveSimulation.Geometries.SelectAll() +interactiveSimulation.Sources.Set(interactiveSource.Subject) +interactiveSimulation.Compute() +interactiveSimulation.ExportRaysAsGeometry() + +interactiveSimulation.FlagLXPActivation = True +interactiveSimulation.Compute() + +lxpResult = SpeosSim.ResultLXP.Find(interactiveSimulation.Name + ".lpf") +lxpResult.RequiredFaces.Set(lxpRequiredFace) +lxpResult.RejectedFaces.Set(lxpRejectedFace) + +lxpResult.Compute() +lxpResult.ExportRaysAsGeometry() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_resultlxp_exporting_rays_as_geometry_lxp_result.md b/2025R1_Test/speos/articles/sim/sim-example/method_resultlxp_exporting_rays_as_geometry_lxp_result.md new file mode 100644 index 0000000000..8d359a6a82 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_resultlxp_exporting_rays_as_geometry_lxp_result.md @@ -0,0 +1,23 @@ +# ResultLXP – Exporting rays as geometry out of a light expert result + +The following script sample shows you an example on how to export rays as geometry out of a Light Expert result. + +```ironpython +Inverse = SpeosSim.SimulationInverse.Find("Inverse.1") +Inverse.Compute() +lxpResult_Inverse = SpeosSim.ResultLXP.Find("Inverse.1.Irradiance.1.lpf") +lxpResult_Inverse.RayNumber = 100 +lxpResult_Inverse.Compute() +lxpResult_Inverse.OpenLpf() # You need to load the LPF first, before ExportRayAsGeometry +lxpResult_Inverse.ExportRaysAsGeometry() +lxpResult_Inverse.CloseLpf() # You need to close the LPF after ExportRayAsGeometry + +Direct = SpeosSim.SimulationDirect.Find("Direct.1") +Direct.Compute() +lxpResult_Direct = SpeosSim.ResultLXP.Find("Direct.1.Irradiance.1.lpf") +lxpResult_Direct.RayNumber = 100 +lxpResult_Direct.Compute() +lxpResult_Direct.OpenLpf() # You need to load the LPF first, before ExportRayAsGeometry +lxpResult_Direct.ExportRaysAsGeometry() +lxpResult_Direct.CloseLpf() # You need to close the LPF after ExportRayAsGeometry +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_resultprojectedgrid_exporting_projected_grid_as_geometry.md b/2025R1_Test/speos/articles/sim/sim-example/method_resultprojectedgrid_exporting_projected_grid_as_geometry.md new file mode 100644 index 0000000000..2bf0a2e1eb --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_resultprojectedgrid_exporting_projected_grid_as_geometry.md @@ -0,0 +1,16 @@ +# ResultProjectedGrid – Exporting a projected grid as geometry + +The following script sample shows you an example on how to export a Projected Grid as geometry. + +```ironpython +interactiveSimulation = SpeosSim.SimulationInteractive.Find("Interactive.1") +interactiveSimulation.Compute() + +results = interactiveSimulation.GetResultFilePaths() + +for resultFile in results: +if (resultFile.ToString().EndsWith("OPTProjectedGrid")): +file = Path.GetFileName(resultFile) +projectedGridResult = SpeosSim.ResultProjectedGrid.Find(file) +projectedGridResult.ExportProjectedGridAsGeometry() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensor3ded_creating_3d_energy_density_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensor3ded_creating_3d_energy_density_sensor.md new file mode 100644 index 0000000000..6f855441b1 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensor3ded_creating_3d_energy_density_sensor.md @@ -0,0 +1,19 @@ +# Sensor3DED – Creating a 3D energy density sensor + +The following script sample shows you an example on how to create a 3D Energy Density Sensor. + +```ironpython +densitySensor = SpeosSim.Sensor3DED.Create() + +densitySensor.OriginPoint.Set(GetRootPart().CoordinateSystems[1]) +densitySensor.XDirection.Set(GetRootPart().CoordinateSystems[1].Axes[0]) +densitySensor.YDirection.Set(GetRootPart().CoordinateSystems[1].Axes[1]) + +densitySensor.SensorType = SpeosSim.Sensor3DED.EnumSensorType.Radiometric +densitySensor.SizeX = 20 +densitySensor.SizeY = 45 +densitySensor.SizeZ = 20 +densitySensor.SamplingX = 200 +densitySensor.SamplingY = 450 +densitySensor.SamplingZ = 200 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensor3dirradiance_creating_3d_irradiance_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensor3dirradiance_creating_3d_irradiance_sensor.md new file mode 100644 index 0000000000..001fe5fd52 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensor3dirradiance_creating_3d_irradiance_sensor.md @@ -0,0 +1,14 @@ +# Sensor3Dirradiance – Creating a 3D irradiance sensor + +The following script sample shows you an example on how to create a 3D Irradiance Sensor. + +```ironpython +irradiance3DSensor = SpeosSim.Sensor3DIrradiance.Create() +irradiance3DSensor.SensorType = SpeosSim.Sensor3DIrradiance.EnumSensorType.Radiometric + +irradiance3DSensor.Geometries.Set(GetRootPart().Bodies[1], GetRootPart().Bodies[2]) + +irradiance3DSensor.Absorption = True +irradiance3DSensor.Transmission = True +irradiance3DSensor.Reflection = True +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorcamera_creating_camera_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorcamera_creating_camera_sensor.md new file mode 100644 index 0000000000..e1a5ad6161 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorcamera_creating_camera_sensor.md @@ -0,0 +1,21 @@ +# SensorCamera – Creating a camera sensor + +The following script sample shows you an example on how to create a Camera Sensor. + +```ironpython +cameraSensor = SpeosSim.SensorCamera.Create() +cameraSensor.Name = "Created camera sensor" + +cameraSensor.OriginPoint.Set(GetRootPart().Curves[0]) +cameraSensor.XDirection.Set(GetRootPart().Curves[1]) +cameraSensor.YDirection.Set(GetRootPart().Curves[2]) + +cameraSensor.DistorsionFile = R".\SPEOS input files\CameraDistortion.OPTDistortion" +cameraSensor.TransmittanceFile = R".\SPEOS input files\OPTIS_Transmittance.spectrum" +cameraSensor.RedSpectrumFile = R".\SPEOS input files\OPTIS_Sensitivity_Red.spectrum" +cameraSensor.GreenSpectrumFile = R".\SPEOS input files\OPTIS_Sensitivity_Green.spectrum" +cameraSensor.BlueSpectrumFile = R".\SPEOS input files\OPTIS_Sensitivity_Blue.spectrum" +cameraSensor.VisuRadius = 100 + +cameraSensor.Visible = False +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensoreye_creating_eye_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensoreye_creating_eye_sensor.md new file mode 100644 index 0000000000..f2fa5c5a68 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensoreye_creating_eye_sensor.md @@ -0,0 +1,21 @@ +# SensorEye – Creating an eye sensor + +The following script sample shows you an example on how to create a Human Eye Sensor. + +```ironpython +eyeSensor = SpeosSim.SensorEye.Create() +eyeSensor.OriginPoint.Set(GetRootPart().Curves[1]) +eyeSensor.TargetPoint.Set(GetRootPart().Curves[0]) +eyeSensor.TopDirection.Set(GetRootPart().Curves[2]) + +eyeSensor.XMirrorExtent = True +eyeSensor.XEnd = 5 +eyeSensor.YMirrorExtent = True +eyeSensor.YEnd = 5 + +tempSamples = eyeSensor.XNbSamples +eyeSensor.XNbSamples = int(tempSamples/10) + +tempSamples = eyeSensor.YNbSamples +eyeSensor.YNbSamples = int(tempSamples/10) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorimmersive_creating_immersive_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorimmersive_creating_immersive_sensor.md new file mode 100644 index 0000000000..17c66a8d07 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorimmersive_creating_immersive_sensor.md @@ -0,0 +1,18 @@ +# SensorImmersive – Creating an immersive sensor + +The following script sample shows you an example on how to create a Immersive Sensor. + +```ironpython +immersiveSensor = SpeosSim.SensorImmersive.Create() + +immersiveSensor.OriginPoint.Set(GetRootPart().CoordinateSystems[1]) +immersiveSensor.TopDirection.Set(GetRootPart().CoordinateSystems[1].Axes[1]) +immersiveSensor.FrontDirection.Set(GetRootPart().Curves[0]) +immersiveSensor.FrontDirectionReverse = True + +immersiveSensor.Back = False +immersiveSensor.Top = False +immersiveSensor.Bottom = False + +immersiveSensor.LayerType = SpeosSim.SensorImmersive.EnumLayerType.OptisLayerSource +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorintensity_creating_intensity_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorintensity_creating_intensity_sensor.md new file mode 100644 index 0000000000..320f77073f --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorintensity_creating_intensity_sensor.md @@ -0,0 +1,19 @@ +# SensorIntensity – Creating an intensity sensor + +The following script sample shows you an example on how to create a 3D Energy Density Sensor. + +```ironpython +densitySensor = SpeosSim.Sensor3DED.Create() + +densitySensor.OriginPoint.Set(GetRootPart().CoordinateSystems[1]) +densitySensor.XDirection.Set(GetRootPart().CoordinateSystems[1].Axes[0]) +densitySensor.YDirection.Set(GetRootPart().CoordinateSystems[1].Axes[1]) + +densitySensor.SensorType = SpeosSim.Sensor3DED.EnumSensorType.Radiometric +densitySensor.SizeX = 20 +densitySensor.SizeY = 45 +densitySensor.SizeZ = 20 +densitySensor.SamplingX = 200 +densitySensor.SamplingY = 450 +densitySensor.SamplingZ = 200 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorirradiance_creating_irradiance_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorirradiance_creating_irradiance_sensor.md new file mode 100644 index 0000000000..4c766eb151 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorirradiance_creating_irradiance_sensor.md @@ -0,0 +1,17 @@ +# SensorIrradiance – Creating an irradiance sensor + +The following script sample shows you an example on how to create an Irradiance Sensor. + +```ironpython +irradianceSensor = SpeosSim.SensorIrradiance.Create() + +irradianceSensor.OriginPoint.Set(GetRootPart().CoordinateSystems[0]) +irradianceSensor.XDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +irradianceSensor.XDirectionReverse = True +irradianceSensor.YDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) + +irradianceSensor.XIsMirrored = True +irradianceSensor.XEnd = 15 +irradianceSensor.YIsMirrored = True +irradianceSensor.YEnd = 15 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorlidar_creating_lidar_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorlidar_creating_lidar_sensor.md new file mode 100644 index 0000000000..0855cb02a2 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorlidar_creating_lidar_sensor.md @@ -0,0 +1,19 @@ +# SensorLidar – Creating a LiDAR sensor + +The following script sample shows you an example on how to create a LiDAR Sensor. + +```ironpython +lidarSensor = SpeosSim.SensorLidar.Create() +lidarSensor.Name = "Created LiDAR sensor" + +lidarSensor.OriginPoint.Set(GetRootPart().Curves[0]) +lidarSensor.SensorXDirection.Set(GetRootPart().Curves[1]) +lidarSensor.SensorYDirection.Set(GetRootPart().Curves[2]) + +lidarSensor.SourceOriginPoint.Set(GetRootPart().Curves[0]) +lidarSensor.SourceXDirection.Set(GetRootPart().Curves[1]) +lidarSensor.SourceYDirection.Set(GetRootPart().Curves[2]) + +lidarSensor.IntensityFile = R".\SPEOS input files\(Defaut) IES C.ies" +lidarSensor.DistorsionFile = R".\SPEOS input files\Distortion.OPTDistortion" +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorobserver_creating_observer_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorobserver_creating_observer_sensor.md new file mode 100644 index 0000000000..37459f8eb1 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorobserver_creating_observer_sensor.md @@ -0,0 +1,29 @@ +# SensorObserver – Creating an observer sensor + +The following script sample shows you an example on how to create an Observer Sensor. + +```ironpython +observerSensor = SpeosSim.SensorObserver.Create() + +observerSensor.OriginPoint.Set(GetRootPart().Curves[0]) +observerSensor.VerticalDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +observerSensor.HorizontalDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) + +observerSensor.ObserverVStart = 20 +observerSensor.ObserverVEnd = 40 +observerSensor.ObserverVSampling = 1 + +observerSensor.ObserverHStart = -180 +observerSensor.ObserverHEnd =180 +observerSensor.ObserverHSampling = 18 + +observerSensor.SizeHMirrorExtent = True +observerSensor.SizeHEnd = 40 +observerSensor.SizeHSampling = 400 +observerSensor.SizeVMirrorExtent = True +observerSensor.SizeVEnd = 40 +observerSensor.SizeVSampling = 400 + +observerSensor.Distance = 200 +observerSensor.Focal = 100 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorradiance_creating_radiance_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorradiance_creating_radiance_sensor.md new file mode 100644 index 0000000000..1d080cda3b --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorradiance_creating_radiance_sensor.md @@ -0,0 +1,24 @@ +# SensorRadiance – Creating a radiance sensor + +The following script sample shows you an example on how to create a Radiance Sensor. + +```ironpython +radianceSensor = SpeosSim.SensorRadiance.Create() +radianceSensor.SensorType = SpeosSim.SensorRadiance.EnumSensorType.Colorimetric +radianceSensor.LayerType = SpeosSim.SensorRadiance.EnumLayerType.OptisLayerSource +radianceSensor.Name = "Outside" + +radianceSensor.OriginPoint.Set(GetRootPart().CoordinateSystems[0]) +radianceSensor.XDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +radianceSensor.YDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) + +radianceSensor.XIsMirrored = True +radianceSensor.XEnd = 800 +radianceSensor.XNbSamples = 800 + +radianceSensor.YIsMirrored = True +radianceSensor.YEnd = 600 +radianceSensor.YNbSamples = 600 + +radianceSensor.Focal = 2000 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sensorrotatinglidar_creating_rotating_lidar_sensor.md b/2025R1_Test/speos/articles/sim/sim-example/method_sensorrotatinglidar_creating_rotating_lidar_sensor.md new file mode 100644 index 0000000000..e277fb96f4 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sensorrotatinglidar_creating_rotating_lidar_sensor.md @@ -0,0 +1,14 @@ +# SensorRotatingLidar – Creating a rotating LiDAR sensor + +The following script sample shows you an example on how to create a Rotating LiDAR Sensor. + +```ironpython +rotatingLidarSensor = SpeosSim.SensorRotatingLidar.Create() +rotatingLidarSensor.Name = "Created geometrical rotating LiDAR sensor" + +rotatingLidarSensor.OriginPoint.Set(GetRootPart().Curves[0]) +rotatingLidarSensor.HorizontalDirection.Set(GetRootPart().Curves[1]) +rotatingLidarSensor.VerticalDirection.Set(GetRootPart().Curves[2]) + +rotatingLidarSensor.VerticalChannelFile = R".\SPEOS input files\hesai.txt" +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_simulationdirect_creating_direct_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_simulationdirect_creating_direct_simulation.md new file mode 100644 index 0000000000..76d4c99ee1 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_simulationdirect_creating_direct_simulation.md @@ -0,0 +1,15 @@ +# SimulationDirect – Creating a direct simulation + +The following script sample shows you an example on how to create a Direct Simulation. + +```ironpython +directSpeosSimulation = SpeosSim.SpeosSimulationDirect.Create() +directSpeosSimulation.Geometries.SelectAll() +directSpeosSimulation.Sources.SelectAll() +directSpeosSimulation.Sensors.SelectAll() +directSpeosSimulation.NbRays = 10000 + +directSpeosSimulation.Compute() +directSpeosSimulation.Isolate() +directSpeosSimulation.LinkedExport() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_simulationhoa_creating_hud_optical_analysis_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_simulationhoa_creating_hud_optical_analysis_simulation.md new file mode 100644 index 0000000000..4728df2ede --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_simulationhoa_creating_hud_optical_analysis_simulation.md @@ -0,0 +1,19 @@ +# SimulationHoa – Creating a HUD optical analysis simulation + +The following script sample shows you an example on how to create a HUD Optical Analysis Simulation. + +```ironpython +hoaSimulation = SpeosSim.SimulationHoa.Create() +hoaSimulation.Name = "Created HOA simulation" + +hoaSimulation.Eyebox.EyeboxCenter.Set(GetRootPart().Components[0].Content.Curves[0]) +hoaSimulation.Winshield.WindshieldInnerSurface.Set(GetRootPart().Components[0].Content.Bodies[0].Faces[0]) + +selection = Selection.Create(GetRootPart().Components[0].Content.Bodies[1].Faces[0], GetRootPart().Components[0].Content.Bodies[2].Faces[0]) +hoaSimulation.Mirrors.MirrorFaces.Set(selection) + +hoaSimulation.PGU.OriginPoint.Set(GetRootPart().Components[0].Content.CoordinateSystems[0]) +hoaSimulation.PGU.XDirection.Set(GetRootPart().Components[0].Content.CoordinateSystems[0].Axes[0]) +hoaSimulation.PGU.YDirection.Set(GetRootPart().Components[0].Content.CoordinateSystems[0].Axes[1]) +hoaSimulation.Compute() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_simulationinteractive_creating_using_interactive_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_simulationinteractive_creating_using_interactive_simulation.md new file mode 100644 index 0000000000..d867ee99a5 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_simulationinteractive_creating_using_interactive_simulation.md @@ -0,0 +1,21 @@ +# SimulationInteractive – Creating and using an interactive simulation + +The following script sample shows you an example on how to create and use an Interactive Simulation. + +```ironpython +interactiveSimulation = SpeosSim.SimulationInteractive.Create() +interactiveSimulation.Geometries.SelectAll() +interactiveSimulation.Sources.Set(interactiveSource.Subject) +interactiveSimulation.Compute() +interactiveSimulation.ExportRaysAsGeometry() + +interactiveSimulation.FlagLXPActivation = True +interactiveSimulation.Compute() + +lxpResult = SpeosSim.ResultLXP.Find(interactiveSimulation.Name + ".lpf") +lxpResult.RequiredFaces.Set(lxpRequiredFace) +lxpResult.RejectedFaces.Set(lxpRejectedFace) + +lxpResult.Compute() +lxpResult.ExportRaysAsGeometry() +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_simulationinteractive_setting_interactive_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_simulationinteractive_setting_interactive_simulation.md new file mode 100644 index 0000000000..26cf0e612d --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_simulationinteractive_setting_interactive_simulation.md @@ -0,0 +1,17 @@ +# SimulationInteractive – Setting an interactive simulation + +The following script sample shows you an example on how to set an Interactive Simulation. + +**GetInteractiveSimulationSettings** returns three Booleans: + - DrawRays + - DrawImpacts + - ReportImpact + +**SetInteractiveSimulationSettings** uses those three Booleans as parameters. + +```ironpython +simulationSettings = interactiveSimulation.GetInteractiveSimulationSettings( ) +for simulationSetting in simulationSettings: +print simulationSetting +interactiveSimulation.SetInteractiveSimulationSettings(True, True, False) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_simulationinverse_creating_inverse_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_simulationinverse_creating_inverse_simulation.md new file mode 100644 index 0000000000..df39e624a8 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_simulationinverse_creating_inverse_simulation.md @@ -0,0 +1,13 @@ +# SimulationInverse – Creating an inverse simulation + +The following script sample shows you an example on how to create an Inverse Simulation. + +```ironpython +inverseSimulation = SpeosSim.SimulationInverse.Create() +inverseSimulation.Geometries.SelectAll() +inverseSimulation.Sensors.SelectAll() + +simulationSetting = inverseSimulation.GetInverseSimulationSettings() +simulationSetting.SetDeterminist(SpeosSim.InverseSimulationSettings.EnumPhotonMapMode.None, 100, 10, False, 0) +inverseSimulation.SetInverseSimulationSettings(simulationSetting) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_simulationrotatinglidar_creating_rotating_lidar_simulation.md b/2025R1_Test/speos/articles/sim/sim-example/method_simulationrotatinglidar_creating_rotating_lidar_simulation.md new file mode 100644 index 0000000000..85b3b35b4c --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_simulationrotatinglidar_creating_rotating_lidar_simulation.md @@ -0,0 +1,12 @@ +# SimulationRotatingLidar – Creating a rotating LiDAR simulation + +The following script sample shows you an example on how to create a Rotating LiDAR Simulation. + +```ironpython +lidarGeoSimu = SpeosSim.SimulationRotatingLidar.Create() +lidarGeoSimu.Name = "New geometrical rotating LiDAR simulation" + +lidarGeoSimu.Geometries.SelectAll() +lidarGeoSimu.Sensors.SelectAll() +lidarGeoSimu.Visualization = SpeosSim.SimulationRotatingLidar.EnumVisualization.ImpactsAndRays +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientciegeneral_creating_cie_general_sky.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientciegeneral_creating_cie_general_sky.md new file mode 100644 index 0000000000..1e59abde28 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientciegeneral_creating_cie_general_sky.md @@ -0,0 +1,14 @@ +# SourceAmbientCIEGeneral – Creating an ambient source CIE standard general sky + +The following script sample shows you an example on how to create an Ambient Source CIE Standard General Sky. + +```ironpython +generalSource = SpeosSim.SourceAmbientCIEGeneral.Create() +generalSource.ZenithDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +generalSource.NorthDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +generalSource.NorthDirectionReverse = True + +generalSource.TimeZone = "OPTIS, France" +generalSource.DateTime = DateTime(2009, 7, 14, 12, 0, 0) +generalSource.CIEType = SpeosSim.SourceAmbientCIEGeneral.EnumCIEType.PARTLY_CLOUDY_SKY_NO_GRADATION_TOWARDS_ZENITH_BRIGHTER_CIRCUMSOLAR_REGION +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientcieovercast_creating_cie_overcast_sky.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientcieovercast_creating_cie_overcast_sky.md new file mode 100644 index 0000000000..606c7df68c --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientcieovercast_creating_cie_overcast_sky.md @@ -0,0 +1,10 @@ +# SourceAmbientCIEOvercast – Creating an ambient source CIE standard overcast sky + +The following script sample shows you an example on how to create an Ambient Source CIE Standard Overcast Sky. + +```ironpython +overcastSource = SpeosSim.SourceAmbientCIEOvercast.Create() +overcastSource.ZenithDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +overcastSource.SpectrumType = SpeosSim.SourceAmbientCIEOvercast.EnumSpectrumType.LibrarySpectrum +overcastSource.SpectrumValueLibrary = ".\\SPEOS input files\\Sky.spectrum" +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientenvironment_creating_environment.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientenvironment_creating_environment.md new file mode 100644 index 0000000000..5a3caff293 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientenvironment_creating_environment.md @@ -0,0 +1,16 @@ +# SourceAmbientEnvironment – Creating an environment ambient source + +The following script sample shows you an example on how to create an Environment Ambient Source. + +```ironpython +environmentSource = SpeosSim.SourceAmbientEnvironment.Create() +environmentSource.ZenithDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +environmentSource.NorthDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +environmentSource.NorthDirectionReverse = True +environmentSource.ImageFile = ".\\SPEOS input files\\uffizi_probe.hdr" + +environmentSource.ColorSpace = SpeosSim.SourceAmbientEnvironment.EnumColorSpace.UserDefinedRGB +environmentSource.RedSpectrumValueLibrary = ".\\SPEOS input files\\Red.spectrum" +environmentSource.GreenSpectrumValueLibrary = ".\\SPEOS input files\\Green.spectrum" +environmentSource.BlueSpectrumValueLibrary = ".\\SPEOS input files\\Blue.spectrum" +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientnaturallight_creating_natural_light.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientnaturallight_creating_natural_light.md new file mode 100644 index 0000000000..cc00e60939 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientnaturallight_creating_natural_light.md @@ -0,0 +1,13 @@ +# SourceAmbientNaturalLight – Creating a natural light ambient source + +The following script sample shows you an example on how to create a Natural Light Ambient Source. + +```ironpython +naturalLight = SpeosSim.SourceAmbientNaturalLight.Create() +naturalLight.ZenithDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +naturalLight.NorthDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +naturalLight.NorthDirectionReverse = True + +naturalLight.TimeZone = "OPTIS, France" +naturalLight.DateTime = DateTime(2009, 7, 14, 12, 0, 0) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientuniform_creating_ambient_source_uniform.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientuniform_creating_ambient_source_uniform.md new file mode 100644 index 0000000000..54c54dfd83 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientuniform_creating_ambient_source_uniform.md @@ -0,0 +1,10 @@ +# SourceAmbientUniform – Creating an ambient source uniform + +The following script sample shows you an example on how to create a Uniform Ambient Source. + +```ironpython +uniformSource = SpeosSim.SourceAmbientUniform.Create() +uniformSource.ZenithDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +uniformSource.SpectrumType = SpeosSim.SourceAmbientUniform.EnumSpectrumType.LibrarySpectrum +uniformSource.SpectrumValueLibrary = ".\\SPEOS input files\\Sky.spectrum" +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientus1976_creating_ambient_source_us_1976.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientus1976_creating_ambient_source_us_1976.md new file mode 100644 index 0000000000..7c4d851a28 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceambientus1976_creating_ambient_source_us_1976.md @@ -0,0 +1,12 @@ +# SourceAmbienUS1976 – Creating an ambient source US standard atmosphere 1976 + +The following script sample shows you an example on how to create a Ambient Source US Standard Atmosphere 1976. + +```ironpython +usSource = SpeosSim.SourceAmbientUS1976.Create() + +usSource.TimeZone = "OPTIS, France" +usSource.DateTime = DateTime(2009, 7, 14, 12, 0, 0) +usSource.ZenithDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +usSource.NorthDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourcedisplay_creating_display_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourcedisplay_creating_display_source.md new file mode 100644 index 0000000000..a0dbd7bccf --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourcedisplay_creating_display_source.md @@ -0,0 +1,27 @@ +# SourceDisplay – Creating a display source + +The following script sample shows you an example on how to create a Display Source. + +```ironpython +displaySource = SpeosSim.SourceDisplay.Create() + +displaySource.OriginPoint.Set(GetRootPart().CoordinateSystems[0]) +displaySource.XDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +displaySource.YDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) + +displaySource.ImageFile = ".\\SPEOS input files\\ATM.bmp" +displaySource.ColorSpace = SpeosSim.SourceDisplay.EnumColorSpace.UserDefinedRGB +displaySource.RedSpectrumValueLibrary = ".\\SPEOS input files\\Red.spectrum" +displaySource.GreenSpectrumValueLibrary = ".\\SPEOS input files\\Green.spectrum" +displaySource.BlueSpectrumValueLibrary = ".\\SPEOS input files\\Blue.spectrum" + +displaySource.Luminance = 1000 + +displaySource.XIsMirrored = True +displaySource.YIsMirrored = True +displaySource.XEnd = 102 +displaySource.YEnd = 74.5 + +displaySource.IntensityType = SpeosSim.SourceDisplay.EnumIntensityType.SymmetricGaussian +displaySource.IntensityFWHMAngle = 60 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceinteractive_creating_interactive_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceinteractive_creating_interactive_source.md new file mode 100644 index 0000000000..e674909852 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceinteractive_creating_interactive_source.md @@ -0,0 +1,15 @@ +# SourceInteractive – Creating an interactive source + +The following script sample shows you an example on how to create an Interactive Source. + +```ironpython +interactiveSource = SpeosSim.SourceInteractive.Create() br>interactiveSource.StartType = SpeosSim.SourceInteractive.EnumStartType.Point +interactiveSource.StartGeometries.Set(GetRootPart().Curves[0]) + +interactiveSource.EndType = SpeosSim.SourceInteractive.EnumEndType.Curve +interactiveSource.EndCurveGeometries.Set(GetRootPart().Curves[1]) + +interactiveSource.EndXSampling = 50 +interactiveSource.Wavelength = 550 +interactiveSource.RayLength = 1 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourceluminaire_creating_luminaire_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourceluminaire_creating_luminaire_source.md new file mode 100644 index 0000000000..7fae178a74 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourceluminaire_creating_luminaire_source.md @@ -0,0 +1,21 @@ +# SourceLuminaire – Creating a luminaire source + +The following script sample shows you an example on how to create a Luminaire Source. + +```ironpython +luminaireSource = SpeosSim.SourceLuminaire.Create() + +luminaireSource.OriginPoint.Set(GetRootPart().CoordinateSystems[0]) +luminaireSource.XDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +luminaireSource.YDirection.Set(GetRootPart().CoordinateSystems[0].Axes[1]) +luminaireSource.YDirectionReverse = True + +luminaireSource.IntensityFile = ".\\SPEOS input files\\BLOCK_REFLECTORS_LED.DirectSimulation.Eulumdat.ldt" +luminaireSource.SpectrumType = SpeosSim.SourceLuminaire.EnumSpectrumType.LibrarySpectrum +luminaireSource.SpectrumValueLibrary = ".\\SPEOS input files\\LXML-PWC2 - Cool White - VN (5000 - 5650K).spectrum" + +luminaireSource.DisplayIntensityDiagram = True + +luminaireSource2 = luminaireSource.Clone() +luminaireSource2.OriginPoint.Set(GetRootPart().Curves[1]) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourcerayfile_creating_ray_file_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourcerayfile_creating_ray_file_source.md new file mode 100644 index 0000000000..12e1727448 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourcerayfile_creating_ray_file_source.md @@ -0,0 +1,16 @@ +# SourceRayFile – Creating a ray file source + +The following script sample shows you an example on how to create a Ray File Source. + +```ironpython +rayFileSource = SpeosSim.SourceRayFile.Create() +rayFileSource.RayFile = ".\\SPEOS input files\\Rays.ray" + +rayFileSource.OriginPoint.Set(GetRootPart().Components[1].Components[2].GetCoordinateSystems()[0]) +rayFileSource.XDirection.Set(GetRootPart().Components[1].Components[2].GetCoordinateSystems()[0].Axes[0]) +rayFileSource.YDirection.Set(GetRootPart().Components[1].Components[2].GetCoordinateSystems()[0].Axes[1]) +rayFileSource.YDirectionReverse = True + +exitFaces = (GetRootPart().Components[1].Components[1].GetBodies()[0].Faces[0], GetRootPart().Components[1].Components[1].GetBodies()[0].Faces[1], GetRootPart().Components[1].Components[1].GetBodies()[0].Faces[2], GetRootPart().Components[1].Components[1].GetBodies()[0].Faces[4]) +rayFileSource.ExitGeometry.Set(exitFaces) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourcerayfile_optimizing_ray_file_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourcerayfile_optimizing_ray_file_source.md new file mode 100644 index 0000000000..c37b528966 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourcerayfile_optimizing_ray_file_source.md @@ -0,0 +1,19 @@ +# SourceRayFile – Optimizing a ray file source + +This page presents you an example on how to optimize a Ray File Source thanks to the **OptimizeRayFile** method. + +```ironpython +rayFileSource = SpeosSim.SourceRayFile.Find("Ray-file.1") + +# this ray file does not need optimization +rayFileSource.RayFile = ".\\Speos input files\\rayfile_LT_QH9G_100k_270114_Speos.RAY" +canRayFileBeOptimized = rayFileSource.OptimizeRayFile() + +print "Has this ray file been optimized? " + str(canRayFileBeOptimized) + +# this ray file does need optimization +rayFileSource.RayFile = ".\\Speos input files\\rayfile_GW_PSLR31em_yellow_20M_20160909_IES_TM25.TM25RAY" +canRayFileBeOptimized = rayFileSource.OptimizeRayFile() + +print "Has this ray file been optimized? " + str(canRayFileBeOptimized) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourcesurface_creating_surface_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourcesurface_creating_surface_source.md new file mode 100644 index 0000000000..f1dae418f7 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourcesurface_creating_surface_source.md @@ -0,0 +1,19 @@ +# SourceSurface – Creating a surface source + +The following script sample shows you an example on how to create a Surface Source. + +```ironpython +surfaceSource = SpeosSim.SourceSurface.Create() +surfaceSource.EmissiveFaces.Set(GetRootPart().Bodies[1].Faces[7]) + +surfaceSource.FluxType = SpeosSim.SourceSurface.EnumFluxType.LuminousFlux +surfaceSource.FluxValueLuminous = 0.3 + +surfaceSource.SpectrumType = SpeosSim.SourceSurface.EnumSpectrumType.WavelengthSpectrum +surfaceSource.SpectrumValueWavelength = 550 + +surfaceSource.IntensityType = SpeosSim.SourceSurface.EnumIntensityType.SymmetricGaussian +surfaceSource.IntensityFWHMAngle = 15 + +surfaceSource.RayLength = 1 +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_sourcethermic_creating_thermic_source.md b/2025R1_Test/speos/articles/sim/sim-example/method_sourcethermic_creating_thermic_source.md new file mode 100644 index 0000000000..52a5ebc42f --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_sourcethermic_creating_thermic_source.md @@ -0,0 +1,18 @@ +# SourceThermic – Creating a thermic source + +The following script sample shows you an example on how to create a Thermic Source. + +```ironpython +thermicSource = SpeosSim.SourceThermic.Create() +thermicSource.Name = "Landsystem" +thermicSource.EmittanceType = SpeosSim.SourceThermic.EnumEmittanceType.TemperatureField + +thermicSource.TemperatureFieldFile = ".\\SPEOS input files\\TemperatureField_Tank.OPTTemperatureField" +thermicSource.OriginPoint.Set(GetRootPart().CoordinateSystems[0]) +thermicSource.XDirection.Set(GetRootPart().CoordinateSystems[0].Axes[0]) +thermicSource.YDirection.Set(GetRootPart().CoordinateSystems[0].Axes[2]) +thermicSource.DisplayModeType = SpeosSim.SourceThermic.EnumDisplayModeType.BoundingBox + +thermicSource.OpticalPropertiesType = SpeosSim.SourceThermic.EnumOpticalPropertiesType.Library +thermicSource.SOPLibrary = ".\\SPEOS input files\\LandSystem.scattering" +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/method_uvmap_applying_uv_mapping.md b/2025R1_Test/speos/articles/sim/sim-example/method_uvmap_applying_uv_mapping.md new file mode 100644 index 0000000000..2afbd28d52 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/method_uvmap_applying_uv_mapping.md @@ -0,0 +1,30 @@ +# Material – Creating and applying UV mapping + +The following script sample shows you an example on how to apply UV mapping on an object. + +```ironpython +concreteTexture = SpeosSim.Material.Create() +concreteTexture.Name = "Concrete_texture" +concreteTexture.OpticalPropertiesType = SpeosSim.Material.EnumOpticalPropertiesType.Surfacic + +concreteTexture.OrientedFaces.Set(GetRootPart().Bodies[0].Faces[1]) +concreteTexture.HasMultipleSOP = True + +concreteSOP = concreteTexture.ListSOP[0] +concreteSOP.SOPType = SpeosSim.SurfaceLayer.EnumSOPType.Library +concreteSOP.SOPLibrary = ".\\SPEOS input files\\Concrete.simplescattering" +concreteSOP.ImageTextureType = SpeosSim.SurfaceLayer.EnumImageTextureType.File +concreteSOP.ImageTextureFilePath = ".\\SPEOS input files\\concrete.png" +concreteSOP.ImageTextureWidth = 500 +concreteSOP.ImageTextureLayer = 1 +concreteSOP.NormalMapType = SpeosSim.SurfaceLayer.EnumNormalMapType.None + +uvMapping = SpeosSim.UVMapping.Create() +uvMapping.Geometries.Set([wallBody.Faces[1]])) + +for customObject in uvMapping.GetChildSubjects(): +uvMap = SpeosSim.UVMap.Find(customObject.GetName()) +uvMap.OriginPoint.Set(sensorOrigin) +uvMap.ProjectionDirection.Set(sensorFrontDirection) +uvMap.OrientationDirection.Set(sensorTopDirection) +``` \ No newline at end of file diff --git a/2025R1_Test/speos/articles/sim/sim-example/sim_script_examples.md b/2025R1_Test/speos/articles/sim/sim-example/sim_script_examples.md new file mode 100644 index 0000000000..03dbaf7245 --- /dev/null +++ b/2025R1_Test/speos/articles/sim/sim-example/sim_script_examples.md @@ -0,0 +1,68 @@ +# SpeosSim script examples + +The following section provides you with a list of script samples to help you create your own script. + +## Material + - [Material – Creating and applying materials](method_uvmap_applying_uv_mapping.md) + - [UVMap – Applying a UV mapping](method_material_creating_applying_materials.md) + +## Component + - [Component3Dtexture – Creating a 3D texture on a geometry](method_component3dtexture_creating_3d_texture_on_geometry.md) + - [ComponentExport – Creating a lightBox export](method_componentexport_creating_lightbox_export.md) + - [ComponentImport – Creating a lightBox import](method_componentimport_creating_lightbox_import.md) + +## Meshing + - [LocalMeshing – Creating a local meshing](method_localmeshing_creating_local_meshing.md) + +## Source + - [SourceAmbientCIEGeneral – Creating an ambient source CIE standard general sky](method_sourceambientciegeneral_creating_cie_general_sky.md) + - [SourceAmbientCIEOvercast – Creating an ambient source CIE standard overcast sky](method_sourceambientcieovercast_creating_cie_overcast_sky.md) + - [SourceAmbientEnvironment – Creating an environment ambient source](method_sourceambientenvironment_creating_environment.md) + - [SourceAmbientNaturalLight – Creating a natural light ambient source](method_sourceambientnaturallight_creating_natural_light.md) + - [SourceAmbientUniform – Creating a uniform ambient source](method_sourceambientuniform_creating_ambient_source_uniform.md) + - [SourceAmbienUS1976 – Creating an ambient source US standard atmosphere 1976](method_sourceambientus1976_creating_ambient_source_us_1976.md) + - [SourceDisplay – Creating a display source](method_sourcedisplay_creating_display_source.md) + - [SourceInteractive – Creating an interactive source](method_sourceinteractive_creating_interactive_source.md) + - [SourceLuminaire – Creating a luminaire source](method_sourceluminaire_creating_luminaire_source.md) + - [SourceRayFile – Creating a ray file source](method_sourcerayfile_creating_ray_file_source.md) + - [SourceRayFile – Optimizing a ray file source](method_sourcerayfile_optimizing_ray_file_source.md) + - [SourceSurface – Creating a surface source](method_sourcesurface_creating_surface_source.md) + - [SourceThermic – Creating a thermic source](method_sourcethermic_creating_thermic_source.md) + +## Sensor + - [Sensor3DED – Creating a 3D energy density sensor](method_sensor3ded_creating_3d_energy_density_sensor.md) + - [Sensor3Dirradiance – Creating a 3D irradiance sensor](method_sensor3dirradiance_creating_3d_irradiance_sensor.md) + - [SensorCamera – Creating a camera sensor](method_sensorcamera_creating_camera_sensor.md) + - [SensorEye – Creating an eye sensor](method_sensoreye_creating_eye_sensor.md) + - [SensorImmersive – Creating an immersive sensor](method_sensorimmersive_creating_immersive_sensor.md) + - [SensorIntensity – Creating an intensity sensor](method_sensorintensity_creating_intensity_sensor.md) + - [SensorIrradiance – Creating an irradiance sensor](method_sensorirradiance_creating_irradiance_sensor.md) + - [SensorLidar – Creating a LiDAR sensor](method_sensorlidar_creating_lidar_sensor.md) + - [SensorObserver – Creating an observer sensor](method_sensorobserver_creating_observer_sensor.md) + - [SensorRadiance – Creating a radiance sensor](method_sensorradiance_creating_radiance_sensor.md) + - [SensorRotatingLidar – Creating a rotating LiDAR sensor](method_sensorrotatinglidar_creating_rotating_lidar_sensor.md) + +## Simulation + - [SimulationInteractive – Setting an interactive simulation](method_simulationinteractive_setting_interactive_simulation.md) + - [SimulationInteractive – Creating and using an interactive simulation](method_simulationinteractive_creating_using_interactive_simulation.md) + - [SimulationDirect – Creating a direct simulation](method_simulationdirect_creating_direct_simulation.md) + - [DirectSImulationSettings – Setting a direct simulation](method_directsimulationsettings_setting_direct_simulation.md) + - [SimulationInverse – Creating an inverse simulation](method_simulationinverse_creating_inverse_simulation.md) + - [InverseSimulationSettings – Setting an inverse simulation](method_inversesimulationsettings_setting_inverse_simulation.md) + - [SimulationRotatingLidar – Creating a rotating LiDAR simulation](method_simulationrotatinglidar_creating_rotating_lidar_simulation.md) + - [SimulationHoa – Creating a HUD optical analysis simulation](method_simulationhoa_creating_hud_optical_analysis_simulation.md) + +## Parameter + - [LXPEnabledSensor – Activating the light expert on a sensor](method_lxpenabledsensor_activating_lxp_on_sensor.md) + - [FTGEnabledGeometry – Activating the fast transmission gathering on a geometry](method_ftgenabledgeometry_activating_ftg_on_geometry.md) + - [EyeboxConfiguration – Defining a HUD optical analysis with multi-eyebox configuration](method_eyeboxconfiguration_defining_hoa_multieyebox.md) + +## Result + - [ResultLXP – Analyzing the interactive simulation light expert result](method_resultlxp_analyzing_interactive_simulation_lxp_result.md) + - [ResultLXP – Exporting rays as geometry out of a light expert result](method_resultlxp_exporting_rays_as_geometry_lxp_result.md) + - [ResultProjectedGrid – Exporting a projected grid as geometry](method_resultprojectedgrid_exporting_projected_grid_as_geometry.md) + +## Options + - [Options – Retrieving values](method_options_retrieving_values.md) + - [Options – Updating values](method_options_updating_values.md) + - [Options – Reseting values](method_options_reseting_values.md) \ No newline at end of file diff --git a/2025R1_Test/speos/articles/speos_getting_started/creating_script.md b/2025R1_Test/speos/articles/speos_getting_started/creating_script.md new file mode 100644 index 0000000000..a637734c16 --- /dev/null +++ b/2025R1_Test/speos/articles/speos_getting_started/creating_script.md @@ -0,0 +1,37 @@ +# Creating a script + +This page shows how to create a script group in Speos. A script group has to be created to use Speos APIs. + +To create a Script Group: + +1. Access the **Groups** panel. +2. Right-click in the panel and click **Create Script Group**. + + *The Group appears in the panel under the Scripts folder.* + + **Note:** Scripts Groups can be created on the root part or on the active part level. + + ![](../images/186802.png) + +3. Right-click the **Group** and click **Edit Script** top open the built-in script editor. + + ![](../images/186803.png) + +4. From the **Script Editor**, if you want to use the new SpaceClaim methods available, select the latest SpaceClaim API version available. + + ![](../images/UG_ASP_images_(interface)_API_V20_Beta.png) + + **Note:** Do not confuse the SpaceClaim API version and the Speos API version. Unlike the SpaceClaim API version, the Speos API version is always the latest version available. + + **Note:** If your script version is not the latest version available, and you want to use geometry objects + retrieved from a Speos object selection attribute (i.e. Items, LinkedObjects), you need to convert the + retrieved geometry objects thanks to the method ConvertToScriptVersion. + +*The Script Group is created and ready to be used. You can now load an existing script or create a script from +scratch using the **Speos API**.* + +**Note:** + +When you run a script on SpaceClaim in headless mode \(without User Interface\), the rendering calculations are performed in all cases. + +If you do not want to perform the rendering calculations in headless mode, create the environment variable **SPEOS\_DISABLE\_RENDERING\_WHEN\_HEADLESS**, and set it to **1**. diff --git a/2025R1_Test/speos/articles/speos_getting_started/forbidden_values_management.md b/2025R1_Test/speos/articles/speos_getting_started/forbidden_values_management.md new file mode 100644 index 0000000000..83543e8ec3 --- /dev/null +++ b/2025R1_Test/speos/articles/speos_getting_started/forbidden_values_management.md @@ -0,0 +1,28 @@ +# Forbidden values management + +The following page presents you how Speos handles the forbidden values when they are defined in scripts. + +Forbidden values correspond to values that do not meet the Speos standards. + +## Out of Range Values + +If a value set in the script is out of the standard range in which it should be, then the previous value is defined. + +Example + +```ironpython +material = SpeosSim.Material.Create() (reflectance =100) +material.SOPReflectance =50; //ok +material.SOPReflectance =150; // keeps the previous value since it should be lower than 100 +``` + +## Decimal Values + +If a value set in the script uses decimals whereas it only allows integer, then the value is rounded up or down to the nearest whole number. + +Example + +```ironpython +material = SpeosSim.Material.Create() +material.SOPReflectance =15,4; // set the value to 15 since it should be an integer +``` \ No newline at end of file diff --git a/2025R1_Test/speos/docfx.json b/2025R1_Test/speos/docfx.json new file mode 100644 index 0000000000..c9670d4726 --- /dev/null +++ b/2025R1_Test/speos/docfx.json @@ -0,0 +1,66 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "src/**.csproj" + ] + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "**/*.png", + "**/*.jpg", + "**/*.gif" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default" + ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false + } +} \ No newline at end of file diff --git a/2025R1_Test/speos/index.md b/2025R1_Test/speos/index.md new file mode 100644 index 0000000000..3ae2506361 --- /dev/null +++ b/2025R1_Test/speos/index.md @@ -0,0 +1,4 @@ +# This is the **HOMEPAGE**. +Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. +## Quick Start Notes: +1. Add images to the *images* folder if the file is referencing an image. diff --git a/2025R1_Test/speos/styles/Google/AMPM.yml b/2025R1_Test/speos/styles/Google/AMPM.yml new file mode 100644 index 0000000000..fbdc6e4f84 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: 'https://developers.google.com/style/word-list' +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/2025R1_Test/speos/styles/Google/Acronyms.yml b/2025R1_Test/speos/styles/Google/Acronyms.yml new file mode 100644 index 0000000000..f41af0189b --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/2025R1_Test/speos/styles/Google/Colons.yml b/2025R1_Test/speos/styles/Google/Colons.yml new file mode 100644 index 0000000000..99363fbd46 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Colons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should be in lowercase." +link: 'https://developers.google.com/style/colons' +nonword: true +level: warning +scope: sentence +tokens: + - ':\s[A-Z]' diff --git a/2025R1_Test/speos/styles/Google/Contractions.yml b/2025R1_Test/speos/styles/Google/Contractions.yml new file mode 100644 index 0000000000..4f6fd5d489 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Contractions.yml @@ -0,0 +1,30 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/contractions' +level: suggestion +ignorecase: true +action: + name: replace +swap: + are not: aren't + cannot: can't + could not: couldn't + did not: didn't + do not: don't + does not: doesn't + has not: hasn't + have not: haven't + how is: how's + is not: isn't + it is: it's + should not: shouldn't + that is: that's + they are: they're + was not: wasn't + we are: we're + we have: we've + were not: weren't + what is: what's + when is: when's + where is: where's + will not: won't diff --git a/2025R1_Test/speos/styles/Google/DateFormat.yml b/2025R1_Test/speos/styles/Google/DateFormat.yml new file mode 100644 index 0000000000..e9d227fa13 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/DateFormat.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/2025R1_Test/speos/styles/Google/Ellipses.yml b/2025R1_Test/speos/styles/Google/Ellipses.yml new file mode 100644 index 0000000000..1e070517bf --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: 'https://developers.google.com/style/ellipses' +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/2025R1_Test/speos/styles/Google/EmDash.yml b/2025R1_Test/speos/styles/Google/EmDash.yml new file mode 100644 index 0000000000..1befe72aa8 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/EmDash.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't put a space before or after a dash." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - remove + - ' ' +tokens: + - '\s[—–]\s' diff --git a/2025R1_Test/speos/styles/Google/EnDash.yml b/2025R1_Test/speos/styles/Google/EnDash.yml new file mode 100644 index 0000000000..b314dc4e98 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/EnDash.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use an em dash ('—') instead of '–'." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - replace + - '-' + - '—' +tokens: + - '–' diff --git a/2025R1_Test/speos/styles/Google/Exclamation.yml b/2025R1_Test/speos/styles/Google/Exclamation.yml new file mode 100644 index 0000000000..eea5fd24bd --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Exclamation.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use exclamation points in text." +link: 'https://developers.google.com/style/exclamation-points' +nonword: true +level: error +action: + name: remove +tokens: + - '\w+!(?:\s|$)' diff --git a/2025R1_Test/speos/styles/Google/FirstPerson.yml b/2025R1_Test/speos/styles/Google/FirstPerson.yml new file mode 100644 index 0000000000..0b7b8828ca --- /dev/null +++ b/2025R1_Test/speos/styles/Google/FirstPerson.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Avoid first-person pronouns such as '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/2025R1_Test/speos/styles/Google/Gender.yml b/2025R1_Test/speos/styles/Google/Gender.yml new file mode 100644 index 0000000000..c8486181d6 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Gender.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use '%s' as a gender-neutral pronoun." +link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' +level: error +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he diff --git a/2025R1_Test/speos/styles/Google/GenderBias.yml b/2025R1_Test/speos/styles/Google/GenderBias.yml new file mode 100644 index 0000000000..9e70190863 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/GenderBias.yml @@ -0,0 +1,47 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: 'https://developers.google.com/style/inclusive-documentation' +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/2025R1_Test/speos/styles/Google/HeadingPunctuation.yml b/2025R1_Test/speos/styles/Google/HeadingPunctuation.yml new file mode 100644 index 0000000000..b538be5b42 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a period at the end of a heading." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - remove + - '.' +tokens: + - '[a-z0-9][.]\s*$' diff --git a/2025R1_Test/speos/styles/Google/Headings.yml b/2025R1_Test/speos/styles/Google/Headings.yml new file mode 100644 index 0000000000..e34d001b77 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Headings.yml @@ -0,0 +1,28 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" +level: warning +scope: heading +match: $sentence +indicators: + - ":" +exceptions: + - Azure + - CLI + - Cosmos + - Docker + - Emmet + - gRPC + - I + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - REPL + - Studio + - TypeScript + - URLs + - Visual + - VS + - Windows diff --git a/2025R1_Test/speos/styles/Google/Latin.yml b/2025R1_Test/speos/styles/Google/Latin.yml new file mode 100644 index 0000000000..ca03b9154b --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Latin.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)(?=[\s,;])': for example + '\b(?:ie|i\.e\.)(?=[\s,;])': that is diff --git a/2025R1_Test/speos/styles/Google/LyHyphens.yml b/2025R1_Test/speos/styles/Google/LyHyphens.yml new file mode 100644 index 0000000000..ac8f557a4a --- /dev/null +++ b/2025R1_Test/speos/styles/Google/LyHyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: 'https://developers.google.com/style/hyphens' +level: error +ignorecase: false +nonword: true +action: + name: edit + params: + - replace + - '-' + - ' ' +tokens: + - '\s[^\s-]+ly-' diff --git a/2025R1_Test/speos/styles/Google/OptionalPlurals.yml b/2025R1_Test/speos/styles/Google/OptionalPlurals.yml new file mode 100644 index 0000000000..f858ea6fee --- /dev/null +++ b/2025R1_Test/speos/styles/Google/OptionalPlurals.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'." +link: 'https://developers.google.com/style/plurals-parentheses' +level: error +nonword: true +action: + name: edit + params: + - remove + - '(s)' +tokens: + - '\b\w+\(s\)' diff --git a/2025R1_Test/speos/styles/Google/Ordinal.yml b/2025R1_Test/speos/styles/Google/Ordinal.yml new file mode 100644 index 0000000000..d1ac7d27e8 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Ordinal.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Spell out all ordinal numbers ('%s') in text." +link: 'https://developers.google.com/style/numbers' +level: error +nonword: true +tokens: + - \d+(?:st|nd|rd|th) diff --git a/2025R1_Test/speos/styles/Google/OxfordComma.yml b/2025R1_Test/speos/styles/Google/OxfordComma.yml new file mode 100644 index 0000000000..b9ba21ebb2 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: 'https://developers.google.com/style/commas' +scope: sentence +level: warning +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/2025R1_Test/speos/styles/Google/Parens.yml b/2025R1_Test/speos/styles/Google/Parens.yml new file mode 100644 index 0000000000..3b8711d0c8 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Parens.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use parentheses judiciously." +link: 'https://developers.google.com/style/parentheses' +nonword: true +level: suggestion +tokens: + - '\(.+\)' diff --git a/2025R1_Test/speos/styles/Google/Passive.yml b/2025R1_Test/speos/styles/Google/Passive.yml new file mode 100644 index 0000000000..3265890e52 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Passive.yml @@ -0,0 +1,184 @@ +extends: existence +link: 'https://developers.google.com/style/voice' +message: "In general, use active voice instead of passive voice ('%s')." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/2025R1_Test/speos/styles/Google/Periods.yml b/2025R1_Test/speos/styles/Google/Periods.yml new file mode 100644 index 0000000000..d24a6a6c03 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Periods.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use periods with acronyms or initialisms such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +level: error +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' diff --git a/2025R1_Test/speos/styles/Google/Quotes.yml b/2025R1_Test/speos/styles/Google/Quotes.yml new file mode 100644 index 0000000000..3cb6f1abd1 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Commas and periods go inside quotation marks." +link: 'https://developers.google.com/style/quotation-marks' +level: error +nonword: true +tokens: + - '"[^"]+"[.,?]' diff --git a/2025R1_Test/speos/styles/Google/Ranges.yml b/2025R1_Test/speos/styles/Google/Ranges.yml new file mode 100644 index 0000000000..3ec045e777 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Ranges.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add words such as 'from' or 'between' to describe a range of numbers." +link: 'https://developers.google.com/style/hyphens' +nonword: true +level: warning +tokens: + - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/2025R1_Test/speos/styles/Google/Semicolons.yml b/2025R1_Test/speos/styles/Google/Semicolons.yml new file mode 100644 index 0000000000..bb8b85b420 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Semicolons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use semicolons judiciously." +link: 'https://developers.google.com/style/semicolons' +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/2025R1_Test/speos/styles/Google/Slang.yml b/2025R1_Test/speos/styles/Google/Slang.yml new file mode 100644 index 0000000000..63f4c248a8 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Slang.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Don't use internet slang abbreviations such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +tokens: + - 'tl;dr' + - ymmv + - rtfm + - imo + - fwiw diff --git a/2025R1_Test/speos/styles/Google/Spacing.yml b/2025R1_Test/speos/styles/Google/Spacing.yml new file mode 100644 index 0000000000..66e45a6b72 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Spacing.yml @@ -0,0 +1,10 @@ +extends: existence +message: "'%s' should have one space." +link: 'https://developers.google.com/style/sentence-spacing' +level: error +nonword: true +action: + name: remove +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/2025R1_Test/speos/styles/Google/Spelling.yml b/2025R1_Test/speos/styles/Google/Spelling.yml new file mode 100644 index 0000000000..527ac07d31 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Spelling.yml @@ -0,0 +1,10 @@ +extends: existence +message: "In general, use American spelling instead of '%s'." +link: 'https://developers.google.com/style/spelling' +ignorecase: true +level: warning +tokens: + - '(?:\w+)nised?' + - 'colour' + - 'labour' + - 'centre' diff --git a/2025R1_Test/speos/styles/Google/Units.yml b/2025R1_Test/speos/styles/Google/Units.yml new file mode 100644 index 0000000000..53522ab2de --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Units.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Put a nonbreaking space between the number and the unit in '%s'." +link: "https://developers.google.com/style/units-of-measure" +nonword: true +level: error +tokens: + - \b\d+(?:B|kB|MB|GB|TB) + - \b\d+(?:ns|ms|s|min|h|d) diff --git a/2025R1_Test/speos/styles/Google/We.yml b/2025R1_Test/speos/styles/Google/We.yml new file mode 100644 index 0000000000..c7ac7d3622 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/2025R1_Test/speos/styles/Google/Will.yml b/2025R1_Test/speos/styles/Google/Will.yml new file mode 100644 index 0000000000..128a918362 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/Will.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Avoid using '%s'." +link: 'https://developers.google.com/style/tense' +ignorecase: true +level: warning +tokens: + - will diff --git a/2025R1_Test/speos/styles/Google/WordList.yml b/2025R1_Test/speos/styles/Google/WordList.yml new file mode 100644 index 0000000000..0d675f2372 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/WordList.yml @@ -0,0 +1,81 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: "https://developers.google.com/style/word-list" +level: warning +ignorecase: false +action: + name: replace +swap: + "(?:API Console|dev|developer) key": API key + "(?:cell ?phone|smart ?phone)": phone|mobile phone + "(?:dev|developer|APIs) console": API console + "(?:e-mail|Email|E-mail)": email + "(?:file ?path|path ?name)": path + "(?:kill|terminate|abort)": stop|exit|cancel|end + "(?:OAuth ?2|Oauth)": OAuth 2.0 + "(?:ok|Okay)": OK|okay + "(?:WiFi|wifi)": Wi-Fi + '[\.]+apk': APK + '3\-D': 3D + 'Google (?:I\-O|IO)': Google I/O + "tap (?:&|and) hold": touch & hold + "un(?:check|select)": clear + above: preceding + account name: username + action bar: app bar + admin: administrator + Ajax: AJAX + a\.k\.a|aka: or|also known as + Android device: Android-powered device + android: Android + API explorer: APIs Explorer + application: app + approx\.: approximately + authN: authentication + authZ: authorization + autoupdate: automatically update + cellular data: mobile data + cellular network: mobile network + chapter: documents|pages|sections + check box: checkbox + check: select + CLI: command-line tool + click on: click|click in + Cloud: Google Cloud Platform|GCP + Container Engine: Kubernetes Engine + content type: media type + curated roles: predefined roles + data are: data is + Developers Console: Google API Console|API Console + disabled?: turn off|off + ephemeral IP address: ephemeral external IP address + fewer data: less data + file name: filename + firewalls: firewall rules + functionality: capability|feature + Google account: Google Account + Google accounts: Google Accounts + Googling: search with Google + grayed-out: unavailable + HTTPs: HTTPS + in order to: to + ingest: import|load + k8s: Kubernetes + long press: touch & hold + network IP address: internal IP address + omnibox: address bar + open-source: open source + overview screen: recents screen + regex: regular expression + SHA1: SHA-1|HAS-SHA1 + sign into: sign in to + sign-?on: single sign-on + static IP address: static external IP address + stylesheet: style sheet + synch: sync + tablename: table name + tablet: device + touch: tap + url: URL + vs\.: versus + World Wide Web: web diff --git a/2025R1_Test/speos/styles/Google/meta.json b/2025R1_Test/speos/styles/Google/meta.json new file mode 100644 index 0000000000..a5da2a8480 --- /dev/null +++ b/2025R1_Test/speos/styles/Google/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Google/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/2025R1_Test/speos/styles/Google/vocab.txt b/2025R1_Test/speos/styles/Google/vocab.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/2025R1_Test/speos/styles/config/vocabularies/ansys/accept.txt b/2025R1_Test/speos/styles/config/vocabularies/ansys/accept.txt new file mode 100644 index 0000000000..db452df874 --- /dev/null +++ b/2025R1_Test/speos/styles/config/vocabularies/ansys/accept.txt @@ -0,0 +1,11 @@ +[Aa]nsys +Speos +dValue +APIs +boolean +Enum +SpeosSim +SpeosDes +SpeosAsm +CAD +bool \ No newline at end of file diff --git a/2025R1_Test/speos/toc.yml b/2025R1_Test/speos/toc.yml new file mode 100644 index 0000000000..59f8010471 --- /dev/null +++ b/2025R1_Test/speos/toc.yml @@ -0,0 +1,5 @@ +- name: Articles + href: articles/ +- name: Api Documentation + href: api/ + homepage: api/index.md diff --git a/2025R1_Test/speos_core/.gitignore b/2025R1_Test/speos_core/.gitignore new file mode 100644 index 0000000000..4378419e7f --- /dev/null +++ b/2025R1_Test/speos_core/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/2025R1_Test/speos_core/.vale.ini b/2025R1_Test/speos_core/.vale.ini new file mode 100644 index 0000000000..5f729aa176 --- /dev/null +++ b/2025R1_Test/speos_core/.vale.ini @@ -0,0 +1,10 @@ +StylesPath = styles + +Vocab = ansys + +MinAlertLevel = suggestion + +Packages = Google + +[*.md] +BasedOnStyles = Vale, Google diff --git a/2025R1_Test/speos_core/api/.gitignore b/2025R1_Test/speos_core/api/.gitignore new file mode 100644 index 0000000000..e8079a3bef --- /dev/null +++ b/2025R1_Test/speos_core/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/2025R1_Test/speos_core/api/index.md b/2025R1_Test/speos_core/api/index.md new file mode 100644 index 0000000000..78dc9c0057 --- /dev/null +++ b/2025R1_Test/speos_core/api/index.md @@ -0,0 +1,2 @@ +# PLACEHOLDER +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/2025R1_Test/speos_core/articles/TOC.yml b/2025R1_Test/speos_core/articles/TOC.yml new file mode 100644 index 0000000000..84d0ced866 --- /dev/null +++ b/2025R1_Test/speos_core/articles/TOC.yml @@ -0,0 +1,13 @@ +- name: Introduction + href: client-speos-core-api-home.md +- name: Speos Core methods + href: speoscore_methods\speoscore_methods.md + items: + - name: OpenFile + href: speoscore_methods\methods_openfile.md + - name: RunSimulation + href: speoscore_methods\methods_runsimulation.md + - name: ShowWindow + href: speoscore_methods\methods_showwindow.md + - name: Speos Core command lines + href: speoscore_methods\methods_command_lines.md \ No newline at end of file diff --git a/2025R1_Test/speos_core/articles/client-speos-core-api-home.md b/2025R1_Test/speos_core/articles/client-speos-core-api-home.md new file mode 100644 index 0000000000..531f65ff4e --- /dev/null +++ b/2025R1_Test/speos_core/articles/client-speos-core-api-home.md @@ -0,0 +1,5 @@ +# Introduction + +You can use Speos Core to run External Simulations. Thanks to Speos Core, you can run locally exported simulations or on a network while keeping Speos or Speos for NX available. + +The **Speos Core Methods** provide you a set of functions to help you automate Speos Core actions. diff --git a/2025R1_Test/speos_core/articles/docfx.json b/2025R1_Test/speos_core/articles/docfx.json new file mode 100644 index 0000000000..212df8a0e2 --- /dev/null +++ b/2025R1_Test/speos_core/articles/docfx.json @@ -0,0 +1,13 @@ +{ + "build": { + "globalMetadata": { + "title": "Speos Core methods 2024 R2", + "summary": "", + "version": "2024 R2", + "product": "Speos", + "programming language": "IronPython", + "product collection": "Optics", + "physics": "Optics" + } + } + } diff --git a/2025R1_Test/speos_core/articles/speoscore_methods/methods_command_lines.md b/2025R1_Test/speos_core/articles/speoscore_methods/methods_command_lines.md new file mode 100644 index 0000000000..8a8dd53ae1 --- /dev/null +++ b/2025R1_Test/speos_core/articles/speoscore_methods/methods_command_lines.md @@ -0,0 +1,22 @@ +# Speos Core command lines + +## Description + +The Speos Core command lines for Speos allow you to create scripts to automate multiple simulation launches without using the Speos Core interface. + +## Command Lines + +|Command Line|Description| +|------------|-----------| +|FILENAME|Speos Core system file to open| +|-C|Command line mode \(no GUI\)| +|-G|Launch Speos GPU Solver| +|-S \(SSS\)|Launch simulation number SSS on FILENAME| +|-t \(ttt\)|Specified simulation thread number| +|-p \(ppp\)|Specify process priority (ppp)
0 - 5
  • 0: idle
  • 2: normal
  • 5: realtime
| +|-r \(rrr\)|Specifies simulation ray or pass number \(rrr\)| +|-D \(DDD\)|Specifies simulation duration in minutes \(DDD\)| +|-J \(JJJ\)|Specifies HPC job name \(JJJ\)| +|-N \(NNN, default = 1\)|Specifies HPC job node number \(NNN\)| +|-W \(WWW\)|Specifies HPC job wall clock in hours \(WWW\)| +|-?|show the help| diff --git a/2025R1_Test/speos_core/articles/speoscore_methods/methods_openfile.md b/2025R1_Test/speos_core/articles/speoscore_methods/methods_openfile.md new file mode 100644 index 0000000000..9fefe18144 --- /dev/null +++ b/2025R1_Test/speos_core/articles/speoscore_methods/methods_openfile.md @@ -0,0 +1,28 @@ +# OpenFile + +## Description + +This function allows you to open a \*.sv5 or \*.speos file. + +## Syntax + +*object*.OpenFile\(BSTR strFileName\) As Int + + - *object*: SPEOSCore + - *BSTR strFileName*: This variable is composed of the path, the filename and the extension + - Int return: returns 0 if succeeded + +## Example + +```ironpython +from System import Type, Activator + +#Creates SPEOSCore COM server +type = Type.GetTypeFromProgID("SV5.document") +SPEOSCore = Activator.CreateInstance(type) + +#Opens sv5 file +fileName = mainPath + "C:\\NewSimulation.sv5" +commandline = "" +retval = SPEOSCore.OpenFile(fileName) +``` \ No newline at end of file diff --git a/2025R1_Test/speos_core/articles/speoscore_methods/methods_runsimulation.md b/2025R1_Test/speos_core/articles/speoscore_methods/methods_runsimulation.md new file mode 100644 index 0000000000..ca08f2ab74 --- /dev/null +++ b/2025R1_Test/speos_core/articles/speoscore_methods/methods_runsimulation.md @@ -0,0 +1,32 @@ +# RunSimulation + +## Description + +This function allows you to run a simulation. + +## Syntax + +*object*.RunSimulation\(Int nSimulationIndex, BSTR strCommandLine\) As Int + + - *object*: SPEOSCore + - *Int nSimulationIndex*: Simulation index, 0 by default + - *BSTR strCommandLine*: This variable corresponds to the **command lines** + - Int return: returns 0 if succeeded + +## Example + +```ironpython +from System import Type, Activator + +#Creates SPEOSCore COM server +type = Type.GetTypeFromProgID("SV5.document") +SPEOSCore = Activator.CreateInstance(type) + +#Opens sv5 file +fileName = mainPath + "C:\\NewSimulation.sv5" +commandline = "" +retval = SPEOSCore.OpenFile(fileName) + +#Runs simulation +retval = SPEOSCore.RunSimulation(0, commandline) +``` \ No newline at end of file diff --git a/2025R1_Test/speos_core/articles/speoscore_methods/methods_showwindow.md b/2025R1_Test/speos_core/articles/speoscore_methods/methods_showwindow.md new file mode 100644 index 0000000000..557097a03b --- /dev/null +++ b/2025R1_Test/speos_core/articles/speoscore_methods/methods_showwindow.md @@ -0,0 +1,26 @@ +# ShowWindow + +## Description + +This function allows you to display the Speos Core window. + +## Syntax + +*object*.ShowWindow\(Int nShowWindow\) As Int + +- *object*: SPEOSCore +- *Int nShowWindow*: 1 to show the window, 0 to hide it +- Int return: returns 0 if succeeded + +## Example + +```ironpython +from System import Type, Activator + +#Creates SPEOSCore COM server +type = Type.GetTypeFromProgID("SV5.document") +SPEOSCore = Activator.CreateInstance(type) + +#Shows SPEOSCore interface +retval = SPEOSCore.ShowWindow(1) +``` diff --git a/2025R1_Test/speos_core/articles/speoscore_methods/speoscore_methods.md b/2025R1_Test/speos_core/articles/speoscore_methods/speoscore_methods.md new file mode 100644 index 0000000000..bbf6a498bf --- /dev/null +++ b/2025R1_Test/speos_core/articles/speoscore_methods/speoscore_methods.md @@ -0,0 +1,8 @@ +# Speos Core methods + +This section provides you with the Speos Core methods and a list of useful command lines. + + - [OpenFile](methods_openfile.md) + - [RunSimulation](methods_runsimulation.md) + - [ShowWindow](methods_showwindow.md) + - [Speos Core command lines](methods_command_lines.md) \ No newline at end of file diff --git a/2025R1_Test/speos_core/docfx.json b/2025R1_Test/speos_core/docfx.json new file mode 100644 index 0000000000..5cd1d48b3e --- /dev/null +++ b/2025R1_Test/speos_core/docfx.json @@ -0,0 +1,64 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "src/**.csproj" + ] + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default" + ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false + } +} \ No newline at end of file diff --git a/2025R1_Test/speos_core/index.md b/2025R1_Test/speos_core/index.md new file mode 100644 index 0000000000..3ae2506361 --- /dev/null +++ b/2025R1_Test/speos_core/index.md @@ -0,0 +1,4 @@ +# This is the **HOMEPAGE**. +Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. +## Quick Start Notes: +1. Add images to the *images* folder if the file is referencing an image. diff --git a/2025R1_Test/speos_core/styles/Google/AMPM.yml b/2025R1_Test/speos_core/styles/Google/AMPM.yml new file mode 100644 index 0000000000..fbdc6e4f84 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: 'https://developers.google.com/style/word-list' +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/2025R1_Test/speos_core/styles/Google/Acronyms.yml b/2025R1_Test/speos_core/styles/Google/Acronyms.yml new file mode 100644 index 0000000000..f41af0189b --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/2025R1_Test/speos_core/styles/Google/Colons.yml b/2025R1_Test/speos_core/styles/Google/Colons.yml new file mode 100644 index 0000000000..99363fbd46 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Colons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should be in lowercase." +link: 'https://developers.google.com/style/colons' +nonword: true +level: warning +scope: sentence +tokens: + - ':\s[A-Z]' diff --git a/2025R1_Test/speos_core/styles/Google/Contractions.yml b/2025R1_Test/speos_core/styles/Google/Contractions.yml new file mode 100644 index 0000000000..4f6fd5d489 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Contractions.yml @@ -0,0 +1,30 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/contractions' +level: suggestion +ignorecase: true +action: + name: replace +swap: + are not: aren't + cannot: can't + could not: couldn't + did not: didn't + do not: don't + does not: doesn't + has not: hasn't + have not: haven't + how is: how's + is not: isn't + it is: it's + should not: shouldn't + that is: that's + they are: they're + was not: wasn't + we are: we're + we have: we've + were not: weren't + what is: what's + when is: when's + where is: where's + will not: won't diff --git a/2025R1_Test/speos_core/styles/Google/DateFormat.yml b/2025R1_Test/speos_core/styles/Google/DateFormat.yml new file mode 100644 index 0000000000..e9d227fa13 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/DateFormat.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/2025R1_Test/speos_core/styles/Google/Ellipses.yml b/2025R1_Test/speos_core/styles/Google/Ellipses.yml new file mode 100644 index 0000000000..1e070517bf --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: 'https://developers.google.com/style/ellipses' +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/2025R1_Test/speos_core/styles/Google/EmDash.yml b/2025R1_Test/speos_core/styles/Google/EmDash.yml new file mode 100644 index 0000000000..1befe72aa8 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/EmDash.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't put a space before or after a dash." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - remove + - ' ' +tokens: + - '\s[—–]\s' diff --git a/2025R1_Test/speos_core/styles/Google/EnDash.yml b/2025R1_Test/speos_core/styles/Google/EnDash.yml new file mode 100644 index 0000000000..b314dc4e98 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/EnDash.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use an em dash ('—') instead of '–'." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - replace + - '-' + - '—' +tokens: + - '–' diff --git a/2025R1_Test/speos_core/styles/Google/Exclamation.yml b/2025R1_Test/speos_core/styles/Google/Exclamation.yml new file mode 100644 index 0000000000..eea5fd24bd --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Exclamation.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use exclamation points in text." +link: 'https://developers.google.com/style/exclamation-points' +nonword: true +level: error +action: + name: remove +tokens: + - '\w+!(?:\s|$)' diff --git a/2025R1_Test/speos_core/styles/Google/FirstPerson.yml b/2025R1_Test/speos_core/styles/Google/FirstPerson.yml new file mode 100644 index 0000000000..0b7b8828ca --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/FirstPerson.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Avoid first-person pronouns such as '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/2025R1_Test/speos_core/styles/Google/Gender.yml b/2025R1_Test/speos_core/styles/Google/Gender.yml new file mode 100644 index 0000000000..c8486181d6 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Gender.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use '%s' as a gender-neutral pronoun." +link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' +level: error +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he diff --git a/2025R1_Test/speos_core/styles/Google/GenderBias.yml b/2025R1_Test/speos_core/styles/Google/GenderBias.yml new file mode 100644 index 0000000000..9e70190863 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/GenderBias.yml @@ -0,0 +1,47 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: 'https://developers.google.com/style/inclusive-documentation' +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/2025R1_Test/speos_core/styles/Google/HeadingPunctuation.yml b/2025R1_Test/speos_core/styles/Google/HeadingPunctuation.yml new file mode 100644 index 0000000000..b538be5b42 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a period at the end of a heading." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - remove + - '.' +tokens: + - '[a-z0-9][.]\s*$' diff --git a/2025R1_Test/speos_core/styles/Google/Headings.yml b/2025R1_Test/speos_core/styles/Google/Headings.yml new file mode 100644 index 0000000000..e34d001b77 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Headings.yml @@ -0,0 +1,28 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" +level: warning +scope: heading +match: $sentence +indicators: + - ":" +exceptions: + - Azure + - CLI + - Cosmos + - Docker + - Emmet + - gRPC + - I + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - REPL + - Studio + - TypeScript + - URLs + - Visual + - VS + - Windows diff --git a/2025R1_Test/speos_core/styles/Google/Latin.yml b/2025R1_Test/speos_core/styles/Google/Latin.yml new file mode 100644 index 0000000000..ca03b9154b --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Latin.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)(?=[\s,;])': for example + '\b(?:ie|i\.e\.)(?=[\s,;])': that is diff --git a/2025R1_Test/speos_core/styles/Google/LyHyphens.yml b/2025R1_Test/speos_core/styles/Google/LyHyphens.yml new file mode 100644 index 0000000000..ac8f557a4a --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/LyHyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: 'https://developers.google.com/style/hyphens' +level: error +ignorecase: false +nonword: true +action: + name: edit + params: + - replace + - '-' + - ' ' +tokens: + - '\s[^\s-]+ly-' diff --git a/2025R1_Test/speos_core/styles/Google/OptionalPlurals.yml b/2025R1_Test/speos_core/styles/Google/OptionalPlurals.yml new file mode 100644 index 0000000000..f858ea6fee --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/OptionalPlurals.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'." +link: 'https://developers.google.com/style/plurals-parentheses' +level: error +nonword: true +action: + name: edit + params: + - remove + - '(s)' +tokens: + - '\b\w+\(s\)' diff --git a/2025R1_Test/speos_core/styles/Google/Ordinal.yml b/2025R1_Test/speos_core/styles/Google/Ordinal.yml new file mode 100644 index 0000000000..d1ac7d27e8 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Ordinal.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Spell out all ordinal numbers ('%s') in text." +link: 'https://developers.google.com/style/numbers' +level: error +nonword: true +tokens: + - \d+(?:st|nd|rd|th) diff --git a/2025R1_Test/speos_core/styles/Google/OxfordComma.yml b/2025R1_Test/speos_core/styles/Google/OxfordComma.yml new file mode 100644 index 0000000000..b9ba21ebb2 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: 'https://developers.google.com/style/commas' +scope: sentence +level: warning +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/2025R1_Test/speos_core/styles/Google/Parens.yml b/2025R1_Test/speos_core/styles/Google/Parens.yml new file mode 100644 index 0000000000..3b8711d0c8 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Parens.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use parentheses judiciously." +link: 'https://developers.google.com/style/parentheses' +nonword: true +level: suggestion +tokens: + - '\(.+\)' diff --git a/2025R1_Test/speos_core/styles/Google/Passive.yml b/2025R1_Test/speos_core/styles/Google/Passive.yml new file mode 100644 index 0000000000..3265890e52 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Passive.yml @@ -0,0 +1,184 @@ +extends: existence +link: 'https://developers.google.com/style/voice' +message: "In general, use active voice instead of passive voice ('%s')." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/2025R1_Test/speos_core/styles/Google/Periods.yml b/2025R1_Test/speos_core/styles/Google/Periods.yml new file mode 100644 index 0000000000..d24a6a6c03 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Periods.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use periods with acronyms or initialisms such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +level: error +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' diff --git a/2025R1_Test/speos_core/styles/Google/Quotes.yml b/2025R1_Test/speos_core/styles/Google/Quotes.yml new file mode 100644 index 0000000000..3cb6f1abd1 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Commas and periods go inside quotation marks." +link: 'https://developers.google.com/style/quotation-marks' +level: error +nonword: true +tokens: + - '"[^"]+"[.,?]' diff --git a/2025R1_Test/speos_core/styles/Google/Ranges.yml b/2025R1_Test/speos_core/styles/Google/Ranges.yml new file mode 100644 index 0000000000..3ec045e777 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Ranges.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add words such as 'from' or 'between' to describe a range of numbers." +link: 'https://developers.google.com/style/hyphens' +nonword: true +level: warning +tokens: + - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/2025R1_Test/speos_core/styles/Google/Semicolons.yml b/2025R1_Test/speos_core/styles/Google/Semicolons.yml new file mode 100644 index 0000000000..bb8b85b420 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Semicolons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use semicolons judiciously." +link: 'https://developers.google.com/style/semicolons' +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/2025R1_Test/speos_core/styles/Google/Slang.yml b/2025R1_Test/speos_core/styles/Google/Slang.yml new file mode 100644 index 0000000000..63f4c248a8 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Slang.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Don't use internet slang abbreviations such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +tokens: + - 'tl;dr' + - ymmv + - rtfm + - imo + - fwiw diff --git a/2025R1_Test/speos_core/styles/Google/Spacing.yml b/2025R1_Test/speos_core/styles/Google/Spacing.yml new file mode 100644 index 0000000000..66e45a6b72 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Spacing.yml @@ -0,0 +1,10 @@ +extends: existence +message: "'%s' should have one space." +link: 'https://developers.google.com/style/sentence-spacing' +level: error +nonword: true +action: + name: remove +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/2025R1_Test/speos_core/styles/Google/Spelling.yml b/2025R1_Test/speos_core/styles/Google/Spelling.yml new file mode 100644 index 0000000000..527ac07d31 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Spelling.yml @@ -0,0 +1,10 @@ +extends: existence +message: "In general, use American spelling instead of '%s'." +link: 'https://developers.google.com/style/spelling' +ignorecase: true +level: warning +tokens: + - '(?:\w+)nised?' + - 'colour' + - 'labour' + - 'centre' diff --git a/2025R1_Test/speos_core/styles/Google/Units.yml b/2025R1_Test/speos_core/styles/Google/Units.yml new file mode 100644 index 0000000000..53522ab2de --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Units.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Put a nonbreaking space between the number and the unit in '%s'." +link: "https://developers.google.com/style/units-of-measure" +nonword: true +level: error +tokens: + - \b\d+(?:B|kB|MB|GB|TB) + - \b\d+(?:ns|ms|s|min|h|d) diff --git a/2025R1_Test/speos_core/styles/Google/We.yml b/2025R1_Test/speos_core/styles/Google/We.yml new file mode 100644 index 0000000000..c7ac7d3622 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/2025R1_Test/speos_core/styles/Google/Will.yml b/2025R1_Test/speos_core/styles/Google/Will.yml new file mode 100644 index 0000000000..128a918362 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/Will.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Avoid using '%s'." +link: 'https://developers.google.com/style/tense' +ignorecase: true +level: warning +tokens: + - will diff --git a/2025R1_Test/speos_core/styles/Google/WordList.yml b/2025R1_Test/speos_core/styles/Google/WordList.yml new file mode 100644 index 0000000000..0d675f2372 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/WordList.yml @@ -0,0 +1,81 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: "https://developers.google.com/style/word-list" +level: warning +ignorecase: false +action: + name: replace +swap: + "(?:API Console|dev|developer) key": API key + "(?:cell ?phone|smart ?phone)": phone|mobile phone + "(?:dev|developer|APIs) console": API console + "(?:e-mail|Email|E-mail)": email + "(?:file ?path|path ?name)": path + "(?:kill|terminate|abort)": stop|exit|cancel|end + "(?:OAuth ?2|Oauth)": OAuth 2.0 + "(?:ok|Okay)": OK|okay + "(?:WiFi|wifi)": Wi-Fi + '[\.]+apk': APK + '3\-D': 3D + 'Google (?:I\-O|IO)': Google I/O + "tap (?:&|and) hold": touch & hold + "un(?:check|select)": clear + above: preceding + account name: username + action bar: app bar + admin: administrator + Ajax: AJAX + a\.k\.a|aka: or|also known as + Android device: Android-powered device + android: Android + API explorer: APIs Explorer + application: app + approx\.: approximately + authN: authentication + authZ: authorization + autoupdate: automatically update + cellular data: mobile data + cellular network: mobile network + chapter: documents|pages|sections + check box: checkbox + check: select + CLI: command-line tool + click on: click|click in + Cloud: Google Cloud Platform|GCP + Container Engine: Kubernetes Engine + content type: media type + curated roles: predefined roles + data are: data is + Developers Console: Google API Console|API Console + disabled?: turn off|off + ephemeral IP address: ephemeral external IP address + fewer data: less data + file name: filename + firewalls: firewall rules + functionality: capability|feature + Google account: Google Account + Google accounts: Google Accounts + Googling: search with Google + grayed-out: unavailable + HTTPs: HTTPS + in order to: to + ingest: import|load + k8s: Kubernetes + long press: touch & hold + network IP address: internal IP address + omnibox: address bar + open-source: open source + overview screen: recents screen + regex: regular expression + SHA1: SHA-1|HAS-SHA1 + sign into: sign in to + sign-?on: single sign-on + static IP address: static external IP address + stylesheet: style sheet + synch: sync + tablename: table name + tablet: device + touch: tap + url: URL + vs\.: versus + World Wide Web: web diff --git a/2025R1_Test/speos_core/styles/Google/meta.json b/2025R1_Test/speos_core/styles/Google/meta.json new file mode 100644 index 0000000000..a5da2a8480 --- /dev/null +++ b/2025R1_Test/speos_core/styles/Google/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Google/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/2025R1_Test/speos_core/styles/Google/vocab.txt b/2025R1_Test/speos_core/styles/Google/vocab.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/2025R1_Test/speos_core/styles/config/vocabularies/ansys/accept.txt b/2025R1_Test/speos_core/styles/config/vocabularies/ansys/accept.txt new file mode 100644 index 0000000000..db452df874 --- /dev/null +++ b/2025R1_Test/speos_core/styles/config/vocabularies/ansys/accept.txt @@ -0,0 +1,11 @@ +[Aa]nsys +Speos +dValue +APIs +boolean +Enum +SpeosSim +SpeosDes +SpeosAsm +CAD +bool \ No newline at end of file diff --git a/2025R1_Test/speos_core/toc.yml b/2025R1_Test/speos_core/toc.yml new file mode 100644 index 0000000000..59f8010471 --- /dev/null +++ b/2025R1_Test/speos_core/toc.yml @@ -0,0 +1,5 @@ +- name: Articles + href: articles/ +- name: Api Documentation + href: api/ + homepage: api/index.md diff --git a/2025R1_Test/speos_labs/.gitignore b/2025R1_Test/speos_labs/.gitignore new file mode 100644 index 0000000000..4378419e7f --- /dev/null +++ b/2025R1_Test/speos_labs/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/2025R1_Test/speos_labs/.vale.ini b/2025R1_Test/speos_labs/.vale.ini new file mode 100644 index 0000000000..d992c7522b --- /dev/null +++ b/2025R1_Test/speos_labs/.vale.ini @@ -0,0 +1,10 @@ +StylesPath = styles + +Vocab = ansys + +MinAlertLevel = suggestion + +Packages = Google + +[*] +BasedOnStyles = Vale, Google \ No newline at end of file diff --git a/2025R1_Test/speos_labs/api/.gitignore b/2025R1_Test/speos_labs/api/.gitignore new file mode 100644 index 0000000000..e8079a3bef --- /dev/null +++ b/2025R1_Test/speos_labs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/2025R1_Test/speos_labs/api/index.md b/2025R1_Test/speos_labs/api/index.md new file mode 100644 index 0000000000..78dc9c0057 --- /dev/null +++ b/2025R1_Test/speos_labs/api/index.md @@ -0,0 +1,2 @@ +# PLACEHOLDER +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/2025R1_Test/speos_labs/articles/_assets/labvr_optisvrmerge.png b/2025R1_Test/speos_labs/articles/_assets/labvr_optisvrmerge.png new file mode 100644 index 0000000000..a008f666c8 Binary files /dev/null and b/2025R1_Test/speos_labs/articles/_assets/labvr_optisvrmerge.png differ diff --git a/2025R1_Test/speos_labs/articles/docfx.json b/2025R1_Test/speos_labs/articles/docfx.json new file mode 100644 index 0000000000..dc54d0a2bc --- /dev/null +++ b/2025R1_Test/speos_labs/articles/docfx.json @@ -0,0 +1,13 @@ +{ + "build": { + "globalMetadata": { + "title": "Speos Labs Automation 2024 R2", + "summary": "", + "version": "2024 R2", + "product": "Speos", + "programming language": "IronPython", + "product collection": "Optics", + "physics": "Optics" + } + } + } diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_bsdf_brdf_anisotropic_surface_viewer.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_bsdf_brdf_anisotropic_surface_viewer.md new file mode 100644 index 0000000000..ef0842c546 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_bsdf_brdf_anisotropic_surface_viewer.md @@ -0,0 +1,65 @@ +# BSDF – BRDF Anisotropic Surface Viewer + +Automation in BSDF - BRDF - Anisotropic Surface Viewer allows you to access to the data inside BSDF, Anisotropic BSDF, BRDF, BSDF180 or unpolished files + +The installation directory includes: + +- The TLB file that describes the Automation interface of the BSDF - BRDF - Anisotropic Surface Viewer. + +- Some HTML example files which have VB script Automation instructions. + +Any language compatible with Automation can be used \(VB, C\#, etc.\). + +## How to call the BSDF - BRDF - Anisotropic Surface Viewer + +Before any call to the BSDF - BRDF - Anisotropic Surface Viewer methods you should use the following instruction: + +``` +Set BSDF_BRDF_Anisotropic_Viewer = CreateObject("SimpleBSDFSurfaceViewer.Application") + +``` + +This instruction automatically runs the BSDF - BRDF - Anisotropic Surface Viewer \(creates an instance of the application\). The other uses of the BSDF - BRDF - Anisotropic Surface Viewer should refer to the variable *BSDF\_BRDF\_Anisotropic\_Viewer* which has been initialized with this instance. + +You could notice that there is no reference to the path where the BSDF\_BRDF\_Anisotropic\_Viewer is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate with *SimpleBSDFSurfaceViewer.Application*. + +## How to call a method + +### VB script language + +To call a method, write *BSDF\_BRDF\_Anisotropic\_Viewer* followed by a **.** then by the name of the method and parameters \(strings between **"** and **"**\), each separated by a comma. For example for opening an XMP map, write the following instructions: + +``` +Dim MyVar MyVar = BSDF_BRDF_Anisotropic_Viewer.OpenFile("MyBRDF.brdf") + +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar holds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the BSDF - BRDF - Anisotropic Viewer. + +### C\# language + +In Framework .NET 4.5, add the TLB reference « BSDF\_BRDF\_Anisotropic\_Viewer.tlb » to the project. + +Add this command: using BSDF\_BRDF\_Anisotropic\_Viewer. + +Then, the commands can be used as follows: + +``` +BSDF_BRDF_Anisotropic_Viewer.Application test = new SimpleBSDFSurfaceViewer.Application(); test.OpenFile("d:\\filename.brdf"); test.Show(1); +``` + +## Syntax description + +All the available methods will be described below using the following syntax: + +``` +object.Method\_Name \(parameter 1, parameter 2, etc.\) as return\_type +``` + +With: + +- Method\_Name: name of the method. +- Parameter n: a keyword for the type of the parameter followed by the parameter name. +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string, etc.\). \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_buildbsdf180.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_buildbsdf180.md new file mode 100644 index 0000000000..b8025d458d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_buildbsdf180.md @@ -0,0 +1,36 @@ +# BuildBSDF180 + +## Description + +Combines two BSDF files, one for the normal direction and one for the opposite direction. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.BuildBSDF180(BSTR bstrNormalFileName, BSTR bstrOppositeFileName)` as Boolean +- *object*: BSDF BRDF Anisotropic Surface Viewer +- *bstrNormalFileName*: path and filename of the BSDF for normal direction +- *bstrOppositeFileName*: path and filename of the BSDF for opposite direction + +## VB script example + +```VB +' Create BSDF viewer +set BSDFViewer = CreateObject("SimpleBSDFSurfaceViewer.Application") +' Builds BSDF 180 +BSDFViewer.BuildBSDF180("C:\Example1.brdf", "C:\Example2.brdf") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates BSDF Viewer COM server +type = Type.GetTypeFromProgID("SimpleBSDFSurfaceViewer.Application") +BSDFViewer = Activator.CreateInstance(type) +# Builds BSDF 180 +BSDFViewer.BuildBSDF180("C:\\Example1.brdf", "C:\\Example2.brdf") +``` + + diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_getreflectioncoefficient.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_getreflectioncoefficient.md new file mode 100644 index 0000000000..b6b9c4f143 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_getreflectioncoefficient.md @@ -0,0 +1,75 @@ +# GetReflectionCoefficient + +## Description + +Gives the coefficient of reflection in reference, and returns: + +- *false*if there is an error in the function \(value is not in the correct interval Theta, Phi or Wavelength\) + +- *True*if there is Reflection + + +## Syntax + +*object*.GetReflectionCoefficient\(theta,phi,Wavelength,reflection\) *object*: BSDFViewer + +## VB script example + +```VB +Sub Test_BSDF_Viewer() +Path = "way of file" ‘example C:\User\nameUser\Documents\ +Set BSDFViewer = CreateObject("SimpleBSDFSurfaceViewer.Application") +MyVar = BSDFViewer.Show(True) +'Open Test File +BSDFViewer.OpenFile (Path + "DD8021.anisotropicbsdf") +‘Test function +Dim reflection As Double +Dim transmission As Double +Dim absorption As Double +Dim Rcheck As Boolean +Dim Tcheck As Boolean +Rcheck = BSDFViewer.GetReflectionCoefficient(90, 0, 464, reflection) +Tcheck = BSDFViewer.GetTransmissionCoefficient(90, 0, 464, transmission) +absorption = 100.0-reflection-transmission +MsgBox reflection & " " & Rcheck +MsgBox transmission & " " & Tcheck +MsgBox absorption +MsgBox ("Fin du test.") +End Sub +``` + +## IronPython example + +```ironpython +from System import Type, Activator +import System +import json +type = Type.GetTypeFromProgID("SimpleBSDFSurfaceViewer.Application") +BSDFViewer = Activator.CreateInstance(type) + +Path = "way of file" #example C:\\User\username\\Documents\\File.anisotropicbsdf +BSDFViewer.Show(1) +#Open Test File +BSDFViewer.OpenFile(Path) +#Test function +my_data_r={} +my_data_t={} +test=clr.Reference[System.Double]() +for wl in range(380,780,10): + my_data_r[str(wl)] =[] + my_data_t[str(wl)] =[] + for theta in range(0,90,1): + rcheck=BSDFViewer.GetReflectionCoefficient(theta, 0 , wl, test) + my_data_r[str(wl)].append(test.Value) + tcheck=BSDFViewer.GetTransmissionCoefficient(theta, 0 , wl, test) + my_data_t[str(wl)].append(test.Value) + +with open(r"C:\temp\output_r.json", "w") as file: + json.dump(my_data_r, file) + file.close() +with open(r"C:\temp\output_t.json", "w") as file: + json.dump(my_data_t, file) + file.close() +``` + + diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_gettransmissioncoefficient.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_gettransmissioncoefficient.md new file mode 100644 index 0000000000..5013807d43 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_gettransmissioncoefficient.md @@ -0,0 +1,76 @@ +# GetTransmissionCoefficient + +## Description + +Gives the coefficient of transmission in reference, and returns: + +- *false*if there is an error in the function \(value is not in the correct interval Theta, Phi or Wavelength\) + +- *True*if there is Transmission + + +## Syntax + +*object*.GetTransmissionCoefficient\(theta,phi,Wavelength,transmission\) *object*: BSDFViewer + +## VB script example + +```VB +Sub Test_BSDF_Viewer() +Path = "way of file" ‘example C:\User\nameUser\Documents\ +Set BSDFViewer = CreateObject("SimpleBSDFSurfaceViewer.Application") +MyVar = BSDFViewer.Show(True) +'Open Test File +BSDFViewer.OpenFile (Path + "DD8021.anisotropicbsdf") +‘Test function +Dim reflection As Double +Dim transmission As Double +Dim absorption As Double +Dim Rcheck As Boolean +Dim Tcheck As Boolean +Rcheck = BSDFViewer.GetReflectionCoefficient(90, 0, 464, reflection) +Tcheck = BSDFViewer.GetTransmissionCoefficient(90, 0, 464, transmission) +absorption = 100.0-reflection-transmission +MsgBox reflection & " " & Rcheck +MsgBox transmission & " " & Tcheck +MsgBox absorption +MsgBox ("Fin du test.") +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +import System +import json +type = Type.GetTypeFromProgID("SimpleBSDFSurfaceViewer.Application") +BSDFViewer = Activator.CreateInstance(type) + +Path = "way of file" #example C:\\User\username\\Documents\\File.anisotropicbsdf +BSDFViewer.Show(1) +#Open Test File +BSDFViewer.OpenFile(Path) +#Test function +my_data_r={} +my_data_t={} +test=clr.Reference[System.Double]() +for wl in range(380,780,10): + my_data_r[str(wl)] =[] + my_data_t[str(wl)] =[] + for theta in range(0,90,1): + rcheck=BSDFViewer.GetReflectionCoefficient(theta, 0 , wl, test) + my_data_r[str(wl)].append(test.Value) + tcheck=BSDFViewer.GetTransmissionCoefficient(theta, 0 , wl, test) + my_data_t[str(wl)].append(test.Value) + +with open(r"C:\temp\output_r.json", "w") as file: + json.dump(my_data_r, file) + file.close() +with open(r"C:\temp\output_t.json", "w") as file: + json.dump(my_data_t, file) + file.close() +``` + + diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_openfile.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_openfile.md new file mode 100644 index 0000000000..1a8b2a3f8c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Short + +- *object*: BSDF - BRDF Anisotropic Viewer, Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_savefile.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_savefile.md new file mode 100644 index 0000000000..9d5b101221 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Short + +- *object*: BSDF - BRDF Anisotropic Viewer, Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path + + + diff --git a/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_show.md b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_bsdf_brdf_anisotropic_surface/editor_bsdf_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_addrayfiles.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_addrayfiles.md new file mode 100644 index 0000000000..00bf440e11 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_addrayfiles.md @@ -0,0 +1,16 @@ +# AddRayFiles + +## Description + +Adds a .ray file to another specified .ray file. + +## Syntax + +*object*.AddRayFiles\(LPCTSTR strAddFileName, LPCTSTR strOutFileName\) As Short + +- *strAddFileName*: .ray + +- *strOutFileName*: .ray + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_changespectrum.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_changespectrum.md new file mode 100644 index 0000000000..0a3aa73d9d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_changespectrum.md @@ -0,0 +1,16 @@ +# ChangeSpectrum + +## Description + +Adds a .spectrum file and saves it in the defined .ray file. + +## Syntax + +*object*.ChangeSpectrum\(LPCTSTR strInFileName, LPCTSTR strOutFileName\) As Short + +- *strInFileName*: .spectrum + +- *strOutFileName*: .ray + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_exportrayfile.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_exportrayfile.md new file mode 100644 index 0000000000..e41eeec17a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_exportrayfile.md @@ -0,0 +1,22 @@ +# ExportRayFile + +## Description + +Creates a .txt or a .dis file based on the .ray file opened. + +## Syntax + +*object*.ExportRayFile\(LPCTSTR strFileName, float fMinWavelength, float fMaxWavelength, int iNbOfWavelength\) As Short + +- *strFileName*: .txt + +- *strFileName*: .dis + +- *fMinWavelength*: corresponds to the minimum wavelength \(to be set only for a .dis file\) + +- *fMaxWavelength*: corresponds to the maximum wavelength \(to be set only for a .dis file\) + +- *iNbOfWavelength*: corresponds to the number of wavelength \(to be set only for a .dis file\) + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_importrayfile.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_importrayfile.md new file mode 100644 index 0000000000..32f752f945 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_importrayfile.md @@ -0,0 +1,16 @@ +# ImportRayFile + +## Description + +Imports a .txt or .dis file to save it as a .ray file. + +## Syntax + +*object*.ImportRayFile\(LPCTSTR strInFileName, LPCTSTR strOutFileName\) As Short + +- *strInFileName*: .txt, .dis + +- *strOutFileName*: .ray + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_invertdirectionofray.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_invertdirectionofray.md new file mode 100644 index 0000000000..5f6d5e3790 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_invertdirectionofray.md @@ -0,0 +1,14 @@ +# InvertDirectionOfRay + +## Description + +Inverts the directions of all rays in the specified .ray file. + +## Syntax + +*object*.InvertDirectionOfRay\(LPCTSTR strOutFileName\) As Short + +- *strOutFileName*: .ray + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_openfile.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_openfile.md new file mode 100644 index 0000000000..f19d5e4c91 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(LPCTSTR strFileName\) As Short + +- *object*: Ray File Editor object + +- *strFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_processenergymax.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_processenergymax.md new file mode 100644 index 0000000000..d1573a3849 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_processenergymax.md @@ -0,0 +1,14 @@ +# ProcessEnergyMax + +## Description + +Adjusts the relative energy of each ray of the specified .ray file. The ray with the highest energy becomes 1 and all other rays are multiplied according to the first ray. + +## Syntax + +*object*.ProcessEnergyMax\(LPCTSTR strOutFileName\) As Short + +- *strOutFileName*: .ray + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_randomizerayfile.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_randomizerayfile.md new file mode 100644 index 0000000000..4ed428b8ea --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_randomizerayfile.md @@ -0,0 +1,14 @@ +# RandomizeRayFile + +## Description + +Completes the specified .ray file with random data. + +## Syntax + +*object*.RandomizeRayFile\(LPCTSTR strOutFileName\) As Short + +- *strOutFileName*: .ray + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_ray_file_editor.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_ray_file_editor.md new file mode 100644 index 0000000000..b40e75095c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_ray_file_editor.md @@ -0,0 +1,65 @@ +# Ray File Editor + +Automation in Ray File Editor allows the user to access to the data inside ray files. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the Ray File Editor, + +- Some HTML example files which have VB script Automation instructions. + + +Any language compatible with Automation can be used \(VB, C\#, etc.\). + +## How to call the Ray File Editor + +Before any call to the Ray File Editor methods you should use the following instruction: + +``` +Set RayEditor = CreateObject("RayEditor.Application") +``` + +This instruction automatically runs the Ray File Editor \(creates an instance of the application\). The other uses of the Ray File Editor should refer to the variable *RayEditor* which has been initialized with this instance. + +You could notice that there is no reference to the path where the Ray File Editor is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *RayEditor.Application*. + +## How to call a method + +### VB script language + +To call a method, write *RayEditor* followed by a **.** then by the name of the method and parameters \(strings between **"** and **"\)**, each separated by **,**. For example for opening a ray file, write the following instructions: + +``` +Dim MyVar MyVar = RayEditor.OpenFile("MyFile.ray") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar holds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the Ray File Editor. + +### C\# language + +In Framework .NET 4.5, add the TLB reference « RayEditor.tlb » to the project. + +Add this command: using RayEditor. + +Then, the commands can be used as follows: + +``` +RayEditor.Application testmap = new RayEditor.Application(); + testmap.OpenFile("d:\\filename.ray"); testfile.Show(1); +``` + +## Syntax description + +All the available methods will be described below using the following syntax: + +``` +object.Method\_Name \(parameter 1, parameter 2, etc.\) as return\_type +``` + +With: + +- Method\_Name: name of the method. +- Parameter n: a keyword for the type of the parameter followed by the parameter name. +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string, etc.\). \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_savefile.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_savefile.md new file mode 100644 index 0000000000..43827fadf3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(LPCTSTR strFileName\) As Short + +- *object*: Ray File Editor object + +- *strFileName*: filename string \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_show.md b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_ray_file/editor_ray_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_basic_methods.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_basic_methods.md new file mode 100644 index 0000000000..8ef8ef040a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_basic_methods.md @@ -0,0 +1,5 @@ +# Basic methods + +- [Filename](editor_user_material_filename.md) +- [OpenFile](editor_user_material_openfile.md) +- [SaveFile](editor_user_material_savefile.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_caption.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_caption.md new file mode 100644 index 0000000000..e61adc0401 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_caption.md @@ -0,0 +1,14 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object*.Caption\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_filename.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_filename.md new file mode 100644 index 0000000000..ce79c18934 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_filename.md @@ -0,0 +1,14 @@ +# Filename + +## Description + +Gets the file name of a file. + +## Syntax + +*object*.FileName\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_getpid.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_getuserconcentration.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_getuserconcentration.md new file mode 100644 index 0000000000..301f1ead04 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_getuserconcentration.md @@ -0,0 +1,40 @@ +# GetUserConcentration + +## Description + +Gets the user concentration of the material defined in the User Material Editor. + +## Syntax + +*object*.GetUserConcentration\(\) As Double + +- *object*: User Material Editor object + +- *Returned value*: User concentration \(double\) + + +## VB script example + +```VB +strMaterialFile = "MyPath\SPEOS input files\Rohm_PLEXIGLAS_8N_65621_green.material" +Set OPTISMaterialViewer = CreateObject("UserMaterialViewer.Application") +OPTISMaterialViewer.OpenFile(strMaterialFile) +MyConcentration = OPTISMaterialViewer.GetUserConcentration() +OPTISMaterialViewer.SaveFile(strMaterialFile) + +``` + +## IronPython example + +``` +from System import Type, Activator +type = Type.GetTypeFromProgID("UserMaterialViewer.Application") +MyUserMaterialViewer = Activator.CreateInstance(type) +strMaterialFile = "MyPath\\SPEOS input files\\Rohm_PLEXIGLAS_8N_65621_green.material" +OPTISMaterialViewer.OpenFile(strMaterialFile) +MyConcentration = OPTISMaterialViewer.GetUserConcentration() +OPTISMaterialViewer.SaveFile(strMaterialFile) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_map_and_display_option.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_map_and_display_option.md new file mode 100644 index 0000000000..d74678e752 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_map_and_display_option.md @@ -0,0 +1,5 @@ +# Map and display option + +- [Caption](editor_user_material_caption.md) +- [GetPID](editor_user_material_getpid.md) +- [Show](editor_user_material_show.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_openfile.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_openfile.md new file mode 100644 index 0000000000..23aa2fb805 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_savefile.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_savefile.md new file mode 100644 index 0000000000..9109ec9e9d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_setuserconcentration.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_setuserconcentration.md new file mode 100644 index 0000000000..4e742fe50d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_setuserconcentration.md @@ -0,0 +1,42 @@ +# SetUserConcentration + +## Description + +Sets the user concentration of the material defined in the User Material Editor. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetUserConcentration\(double dUserConcentration\) as Integer + +- *object*: User Material Editor object + +- *dUserConcentration*: User concentration \(double\) + + +## VB script example + +```VB +strMaterialFile = "MyPath\SPEOS input files\Rohm_PLEXIGLAS_8N_65621_green.material" +MyConcentration = 112 +Set OPTISMaterialViewer = CreateObject("UserMaterialViewer.Application") +OPTISMaterialViewer.OpenFile(strMaterialFile) +OPTISMaterialViewer.SetUserConcentration(MyConcentration ) +OPTISMaterialViewer.SaveFile(strMaterialFile) + +``` + +## IronPython example + +``` +from System import Type, Activator +type = Type.GetTypeFromProgID("UserMaterialViewer.Application") +MyUserMaterialViewer = Activator.CreateInstance(type) +strMaterialFile = "MyPath\\SPEOS input files\\Rohm_PLEXIGLAS_8N_65621_green.material" +OPTISMaterialViewer.OpenFile(strMaterialFile) +userConcentration = 10 +MyConcentration = OPTISMaterialViewer.SetUserConcentration(userConcentration) +OPTISMaterialViewer.SaveFile(strMaterialFile) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_show.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_user_concentration.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_user_concentration.md new file mode 100644 index 0000000000..99d790053e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_user_concentration.md @@ -0,0 +1,4 @@ +# User concentration + +- [GetUserConcentration](editor_user_material_getuserconcentration.md) +- [SetUserConcentration](editor_user_material_setuserconcentration.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_user_material_editor.md b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_user_material_editor.md new file mode 100644 index 0000000000..da1571444d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/editor_user_material/editor_user_material_user_material_editor.md @@ -0,0 +1,47 @@ +# User Material Editor + +Automation in User Material Editor allows you to access to the data inside material files. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the User Material Editor, +- Some HTML example files which have VB script Automation instructions. + +All examples are given using VB Script language but any other language compatible with Automation can be used. + +## How to call the User Material Editor + +Before any call to the User Material Editor methods you should use the following instruction: + +``` +Set Viewer = CreateObject("UserMaterialViewer.Application") +``` + +This instruction automatically runs the User Material Editor \(creates an instance of the application\). The other uses of the User Material Editor should refer to the variable *Viewer* which has been initialized with this instance. + +You could notice that there is no reference to the path where the User Material Editor is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *UserMaterialEditor.Application*. + +## How to call a method + +To call a method, write *Viewer* followed by a **.** then by the name of the method and parameters between **"** and **"**, each separated by **,**. For example for opening a material file, write the following instructions: + +``` +Dim MyVar MyVar = Viewer.OpenFile("MyMaterial.material") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar olds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the User Material Editor. + +All the available methods will be described below using the following syntax: + +``` +\[number\] return\_type Method\_Name\(parameter 1, parameter 2,...\) ; +``` + +with: + +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. +- Parameter n: A keyword for the type of the parameter followed by the parameter name. \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/lab_api_home.md b/2025R1_Test/speos_labs/articles/lab_api_home.md new file mode 100644 index 0000000000..91fa5c8809 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/lab_api_home.md @@ -0,0 +1,38 @@ +# Introduction + +## General description + +With Automation, you can communicate with any Windows application. Automation can replace the old specific macro way method for writing script. + +With automation you can: + +- Write script using any language compatible with Automation \(VB Script, C++\), +- Directly access results data without knowing specific format \(like XMP file\), +- Write your own HTML reports that automatically analyze the results, +- Write your own optimization code. + +## Technical description + +Automation is based on COM \(Component Object Model\). This is a standard way to describe the interface exposed by a Windows application to other Windows applications. + +The interface is described using the IDL \(Interface Description Language\). This interface is used to give the description of all data and functions \(and their parameters\) that can be called from another application. + +The exposed data are called Properties. + +The exposed functions are called Methods. + +## Development tools + +If you want to use Automation, you need to decide which language to use depending on your needs. + +For basic needs, the VB Script or VBA language is the easiest to understand and to use. When writing a macro with this software, the VB Script language is used. The macro can mix CAD VB Script or VBA instructions and Virtual Photometric Lab VB Script instructions: using your own merit function you have your own optimization tool. + +For more complex needs, you may use C++, which is a more difficult language to learn for non-developers. + +## Before starting + +As automation is an application that is handled by the Windows registry, be aware that the software version that is used is based on the version that is currently registered (the last version you launched). +If you have multiple versions of Speos Labs installed, make sure to register the version of the viewer/editor you want to use for automation. +To do so, right-click the viewer/editor in the version to use for automation and click Run as administrator. + +For API functions using Variant variables as input, Iron Python is not supported. diff --git a/2025R1_Test/speos_labs/articles/manifest.json b/2025R1_Test/speos_labs/articles/manifest.json new file mode 100644 index 0000000000..59a9841aa6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/manifest.json @@ -0,0 +1,18 @@ +{ + "homepages": [], + "source_base_path": "D:/GitHub/2024_R2/speos_labs/articles", + "files": [], + "incremental_info": [ + { + "status": { + "can_incremental": true, + "details": "Can support incremental post processing.", + "incrementalPhase": "postProcessing", + "total_file_count": 0, + "skipped_file_count": 0 + }, + "processors": {} + } + ], + "version_info": {} +} \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_addparam.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_addparam.md new file mode 100644 index 0000000000..60e12c1aea --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_addparam.md @@ -0,0 +1,16 @@ +# AddParam + +## Description + +Sets the floating point value for operations that require a parameter. Returns 0 if the call has succeeded, 1 otherwise. + +## Syntax + +*object*.AddParam\(double dValue\) As Short + +- *object*: Photometric Calc object + +- *dValue*: floating point value for the operation parameter + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_fileresult.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_fileresult.md new file mode 100644 index 0000000000..03e55ea182 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_fileresult.md @@ -0,0 +1,16 @@ +# FileResult + +## Description + +Defines the name of the result file. Returns 0 if the call has succeeded, 1 otherwise. + +## Syntax + +*object*.FileResult\(BSTR bstrFileResult\) As Short + +- *object*: Photometric Calc object + +- *bstrFileResult*: result filename string + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_filesource1.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_filesource1.md new file mode 100644 index 0000000000..fe29d6acd7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_filesource1.md @@ -0,0 +1,16 @@ +# FileSource1 + +## Description + +Defines the name of the first source file. Returns 0 if the call has succeeded, 1 otherwise. + +## Syntax + +*object*.FileSource1\(BSTR bstrFileSource1\) As Short + +- *object*: Photometric Calc object + +- *bFileSource1*: first source name string + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_filesource2.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_filesource2.md new file mode 100644 index 0000000000..4d19df503e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_filesource2.md @@ -0,0 +1,16 @@ +# FileSource2 + +## Description + +Defines the name of the second source file. Returns 0 if the call has succeeded, 1 otherwise. + +## Syntax + +*object*.FileSource2\(BSTR bstrFileSource2\) As Short + +- *object*: Photometric Calc object + +- *bFileSource1*: second source name string + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_getpid.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_operation.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_operation.md new file mode 100644 index 0000000000..e5b3c7b5c4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_operation.md @@ -0,0 +1,44 @@ +# Operation + +## Description + +Defines the name of the operation. Returns 0 if the call succeeded, 1 otherwise. + +## Syntax + +*object*.Operation\(BSTR bstrOperationName\) As Short + +- *object*: Photometric Calc object + +- *bstrOperationName*: operation name + + "Addition" + + "Subtraction" + + "ValueMultiplication" + + "MapMultiplication" + + "MapDivision" + + "SymetryVertical" + + "SymetryHorizontal" + + "VerticalFlip" + + "HorizontalFlip" + + "Rotation" + + "MergeResult" + + "MapUnion" + + "SpectrumMultiplication" + + "MapSignalToNoiseRatio" + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_photometric_calc.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_photometric_calc.md new file mode 100644 index 0000000000..65f4530b7b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_photometric_calc.md @@ -0,0 +1,44 @@ +# Photometric Calc + +Automation in Photometric Calc allows you to access to the data inside XMP maps. + +The installation directory includes the TLB file that describes the Automation interface of the Photometric Calc. + +## How to call the Photometric Calc + +Before any call to Photometric Calc methods you should use the following instruction : + +``` +Set PhotometricCalc = CreateObject("VPLab.Application") + +``` + +This instruction automatically runs Photometric Calc \(creates an instance of the application\). The other uses of Photometric Calc should refer to the variable *PhotometricCalc* which has been initialized with this instance. + +You could notice that there is no reference to the path where Photometric Calc is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *VPLab.Application*. + +## How to call a method + +To call a method, write *PhotometricCalc* followed by a **.** then by the name of the method and parameters between **"** and **"**, each separated by **,**. For example for displaying the Photometric Calc window, write the following instructions: + +``` +Dim MyVar MyVar = PhotometricCalc.Show(True) + +``` + +The *Show* method takes a short as parameter. The variable MyVar olds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of Photometric Calc. + +All the available methods will be described below using the following syntax: + +``` +[number] return_type Method_Name(parameter 1, parameter 2,...) ; +``` + +with: + +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. +- Parameter n: A keyword for the type of the parameter followed by the parameter name. diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_process.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_process.md new file mode 100644 index 0000000000..7ef0ab74ab --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_process.md @@ -0,0 +1,14 @@ +# Process + +## Description + +Process the operation. Returns 0 if the call has succeeded, 1 otherwise. + +## Syntax + +*object*.Process\(\) As Short + +- *object*: Photometric Calc object + + + diff --git a/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_show.md b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/photometric_calc/photometric_calc_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/toc.yml b/2025R1_Test/speos_labs/articles/toc.yml new file mode 100644 index 0000000000..f28db47a74 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/toc.yml @@ -0,0 +1,829 @@ +- name: Introduction + href: lab_api_home.md +- name: Virtual Photometric Lab + href: virtual_photometric_lab\labvp_virtual_photometric_lab.md + items: + - name: Basic methods + href: virtual_photometric_lab\basic_methods\labvp_basic_methods.md + items: + - name: ImportTemplate + href: virtual_photometric_lab\basic_methods\labvp_importtemplate.md + - name: ExportTemplate + href: virtual_photometric_lab\basic_methods\labvp_exporttemplate.md + - name: MapType + href: virtual_photometric_lab\basic_methods\labvp_maptype.md + - name: OpenFile + href: virtual_photometric_lab\basic_methods\labvp_openfile.md + - name: ReturnUnitType + href: virtual_photometric_lab\basic_methods\labvp_returnunittype.md + - name: ReturnValueType + href: virtual_photometric_lab\basic_methods\labvp_returnvaluetype.md + - name: SaveFile + href: virtual_photometric_lab\basic_methods\labvp_savefile.md + - name: SetColorMode + href: virtual_photometric_lab\basic_methods\labvp_setcolormode.md + - name: SetReturnUnitType + href: virtual_photometric_lab\basic_methods\labvp_setreturnunittype.md + - name: UnitType + href: virtual_photometric_lab\basic_methods\labvp_unittype.md + - name: ValueType + href: virtual_photometric_lab\basic_methods\labvp_valuetype.md + - name: GetIntensityType + href: virtual_photometric_lab\basic_methods\labvp_getintensitytype.md + - name: GetAxisUnitName + href: virtual_photometric_lab\basic_methods\labvp_getaxisunitname.md + - name: GetPID + href: virtual_photometric_lab\basic_methods\labvp_getpid.md + - name: Map information + href: virtual_photometric_lab\map_information\labvp_map_information.md + items: + - name: Filename + href: virtual_photometric_lab\map_information\labvp_filename.md + - name: Position + href: virtual_photometric_lab\map_information\labvp_position.md + - name: WMax + href: virtual_photometric_lab\map_information\labvp_wmax.md + - name: WMin + href: virtual_photometric_lab\map_information\labvp_wmin.md + - name: WNb + href: virtual_photometric_lab\map_information\labvp_wnb.md + - name: WSampleWidth + href: virtual_photometric_lab\map_information\labvp_wsamplewidth.md + - name: XMax + href: virtual_photometric_lab\map_information\labvp_xmax.md + - name: XMin + href: virtual_photometric_lab\map_information\labvp_xmin.md + - name: XNb + href: virtual_photometric_lab\map_information\labvp_xnb.md + - name: XWidth + href: virtual_photometric_lab\map_information\labvp_xwidth.md + - name: XSampleWidth + href: virtual_photometric_lab\map_information\labvp_xsamplewidth.md + - name: XYZToBlackbodyTemperature + href: virtual_photometric_lab\map_information\labvp_xyztoblackbodytemperature.md + - name: YMax + href: virtual_photometric_lab\map_information\labvp_ymax.md + - name: Ymin + href: virtual_photometric_lab\map_information\labvp_ymin.md + - name: YNb + href: virtual_photometric_lab\map_information\labvp_ynb.md + - name: YHeight + href: virtual_photometric_lab\map_information\labvp_yheight.md + - name: YSampleHeight + href: virtual_photometric_lab\map_information\labvp_ysampleheight.md + - name: Get value on map + href: virtual_photometric_lab\get_value_on_map\labvp_get_value_on_map.md + items: + - name: GetColor + href: virtual_photometric_lab\get_value_on_map\labvp_getcolor.md + - name: GetColorSystemColorNames + href: virtual_photometric_lab\get_value_on_map\labvp_getcolorsystemcolornames.md + - name: GetCurrentColorSystem + href: virtual_photometric_lab\get_value_on_map\labvp_getcurrentcolorsystem.md + - name: GetGeneralCRI + href: virtual_photometric_lab\get_value_on_map\labvp_getgeneralcri.md + - name: GetPixelListOnSurface + href: virtual_photometric_lab\get_value_on_map\labvp_getpixellistonsurface.md + - name: GetPrecision + href: virtual_photometric_lab\get_value_on_map\labvp_getprecision.md + - name: GetSelectedLayer + href: virtual_photometric_lab\get_value_on_map\labvp_getselectedlayer.md + - name: GetSelectedLayersUser + href: virtual_photometric_lab\get_value_on_map\labvp_getselectedlayersuser.md + - name: GetValue + href: virtual_photometric_lab\get_value_on_map\labvp_getvalue.md + - name: GetValue1 + href: virtual_photometric_lab\get_value_on_map\labvp_getvalue1.md + - name: GetValue2 + href: virtual_photometric_lab\get_value_on_map\labvp_getvalue2.md + - name: GetValueEllipse + href: virtual_photometric_lab\get_value_on_map\labvp_getvalueellipse.md + - name: GetValueRectangle + href: virtual_photometric_lab\get_value_on_map\labvp_getvaluerectangl.md + - name: SetMinMax + href: virtual_photometric_lab\get_value_on_map\labvp_setminmax.md + - name: Surface calculation on map + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surface_calculation_on_map.md + items: + - name: SurfaceEllipseBarycentre + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsebarycentre.md + - name: SurfaceEllipseCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsecalculation.md + - name: SurfaceEllipseColor + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsecolor.md + - name: SurfaceEllipseExport + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipseexport.md + - name: SurfaceEllipseGeneralCRI + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsegeneralcri.md + - name: SurfaceEllipseSigma + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsesigma.md + - name: SurfaceEllipseExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipseexportspectrum.md + - name: SurfaceLineCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelinecalculation.md + - name: SurfaceLineCalculation2 + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelinecalculation2.md + - name: SurfaceLineExportTXT + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelineexporttxt.md + - name: SurfaceLineExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelineexportspectrum.md + - name: SurfacePolylineExportTXT + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolylineexporttxt.md + - name: SurfacePolylineExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolylineexportspectrum.md + - name: SurfacePolygonBarycentre + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonbarycentre.md + - name: SurfacePolygonCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygoncalculation.md + - name: SurfacePolygonColor + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygoncolor.md + - name: SurfacePolygonExport + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonexport.md + - name: SurfacePolygonGeneralCRI + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygongeneralcri.md + - name: SurfacePolygonSigma + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonsigma.md + - name: SurfacePolygonExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonexportspectrum.md + - name: SurfacePointExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepointexportspectrum.md + - name: SurfaceRectangleBarycentre + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglebarycentre.md + - name: SurfaceRectangleCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglecalculation.md + - name: SurfaceRectangleColor + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglecolor.md + - name: SurfaceRectangleExport + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectangleexport.md + - name: SurfaceRectangleGeneralCRI + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglegeneralcri.md + - name: SurfaceRectangleSigma + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglesigma.md + - name: SurfaceRectangleExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectangleexportspectrum.md + - name: SetSurfaceThresholdMax + href: virtual_photometric_lab\surface_calculation_on_map\labvp_setsurfacethresholdma.md + - name: SetSurfaceThresholdMin + href: virtual_photometric_lab\surface_calculation_on_map\labvp_setsurfacethresholdmin.md + - name: RemoveSurfaceThresholdMax + href: virtual_photometric_lab\surface_calculation_on_map\labvp_removesurfacethresholdmax.md + - name: RemoveSurfaceThresholdMin + href: virtual_photometric_lab\surface_calculation_on_map\labvp_removesurfacethresholdmin.md + - name: GetMagnitude + href: virtual_photometric_lab\surface_calculation_on_map\labvp_getmagnitude.md + - name: SetMagnitude + href: virtual_photometric_lab\surface_calculation_on_map\labvp_setmagnitude.md + - name: MeasuresExportTXT + href: virtual_photometric_lab\surface_calculation_on_map\labvp_measuresexporttxt.md + - name: Creating a new map + href: virtual_photometric_lab\create_new_map\labvp_creating_a_new_map.md + items: + - name: CreateMap + href: virtual_photometric_lab\create_new_map\labvp_createmap.md + - name: ImportTXT + href: virtual_photometric_lab\create_new_map\labvp_importtxt.md + - name: SetXMax + href: virtual_photometric_lab\create_new_map\labvp_setxmax.md + - name: SetXMin + href: virtual_photometric_lab\create_new_map\labvp_setxmin.md + - name: SetYMax + href: virtual_photometric_lab\create_new_map\labvp_setymax.md + - name: SetYMin + href: virtual_photometric_lab\create_new_map\labvp_setymin.md + - name: Exporting data + href: virtual_photometric_lab\exporting_data\labvp_exporting_data.md + items: + - name: ExportChart3D + href: virtual_photometric_lab\exporting_data\labvp_exportchart3d.md + - name: ExportChart3D3D + href: virtual_photometric_lab\exporting_data\labvp_exportchart3d3d.md + - name: ExportTXT + href: virtual_photometric_lab\exporting_data\labvp_exporttxt.md + - name: ExportPF + href: virtual_photometric_lab\exporting_data\labvp_exportpf.md + - name: ExportXMP + href: virtual_photometric_lab\exporting_data\labvp_exportxmp.md + - name: ExportXMPtoIntensity + href: virtual_photometric_lab\exporting_data\labvp_exportxmptointensity.md + - name: ExportXMPImage + href: virtual_photometric_lab\exporting_data\labvp_exportxmpimage.md + - name: ExportXMPtoResizedImage + href: virtual_photometric_lab\exporting_data\labvp_exportxmptoresizedimage.md + - name: ExportXMPIso + href: virtual_photometric_lab\exporting_data\labvp_exportxmpiso.md + - name: ExportXMPtoHDRI + href: virtual_photometric_lab\exporting_data\labvp_exportxmptohdri.md + - name: Filtering data + href: virtual_photometric_lab\filtering_data\labvp_filtering_data.md + items: + - name: Filtering + href: virtual_photometric_lab\filtering_data\labvp_filtering.md + - name: FilteringRemoveHighestPeaks + href: virtual_photometric_lab\filtering_data\labvp_filteringremovehighestpeaks.md + - name: Map and display option + href: virtual_photometric_lab\map_and_display_option\labvp_map_and_display_option.md + items: + - name: AutomaticUpdate + href: virtual_photometric_lab\map_and_display_option\labvp_automaticupdate.md + - name: AxisSymetry + href: virtual_photometric_lab\map_and_display_option\labvp_axissymetry.md + - name: Caption + href: virtual_photometric_lab\map_and_display_option\labvp_caption.md + - name: FillBackground + href: virtual_photometric_lab\map_and_display_option\labvp_fillbackground.md + - name: GetComment + href: virtual_photometric_lab\map_and_display_option\labvp_getcomment.md + - name: HorizontalFlip + href: virtual_photometric_lab\map_and_display_option\labvp_horizontalflip.md + - name: GetHorizontalFlip + href: virtual_photometric_lab\map_and_display_option\labvp_gethorizontalflip.md + - name: IsoCurves + href: virtual_photometric_lab\map_and_display_option\labvp_isocurves.md + - name: LoadScaleLevels + href: virtual_photometric_lab\map_and_display_option\labvp_loadscalelevels.md + - name: NightVisionGoggles + href: virtual_photometric_lab\map_and_display_option\labvp_nightvisiongoggles.md + - name: SaveScaleImage + href: virtual_photometric_lab\map_and_display_option\labvp_savescaleimage.md + - name: SetAlwaysOnTop + href: virtual_photometric_lab\map_and_display_option\labvp_setalwaysontop.md + - name: SetAutomaticGrid + href: virtual_photometric_lab\map_and_display_option\labvp_setautomaticgrid.md + - name: SetComment + href: virtual_photometric_lab\map_and_display_option\labvp_setcomment.md + - name: SetDisplayMode + href: virtual_photometric_lab\map_and_display_option\labvp_setdisplaymode.md + - name: SetGridOrigin + href: virtual_photometric_lab\map_and_display_option\labvp_setgridorigin.md + - name: SetPrimaryGridSteps + href: virtual_photometric_lab\map_and_display_option\labvp_setprimarygridsteps.md + - name: SetSecondaryGraduationNbs + href: virtual_photometric_lab\map_and_display_option\labvp_setsecondarygraduationnbs.md + - name: Show + href: virtual_photometric_lab\map_and_display_option\labvp_show.md + - name: ShowPrimaryGrid + href: virtual_photometric_lab\map_and_display_option\labvp_showprimarygrid.md + - name: ShowSecondaryGrid + href: virtual_photometric_lab\map_and_display_option\labvp_showsecondarygrid.md + - name: ShowRuler + href: virtual_photometric_lab\map_and_display_option\labvp_showruler.md + - name: SpectralFiltering + href: virtual_photometric_lab\map_and_display_option\labvp_spectralfiltering.md + - name: UpdateDisplayAndData + href: virtual_photometric_lab\map_and_display_option\labvp_updatedisplayanddata.md + - name: SetLogScale + href: virtual_photometric_lab\map_and_display_option\labvp_setlogscale.md + - name: Extended and spectral map + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extended_and_spectral_map.md + items: + - name: ExtendedExportTXT + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedexporttxt.md + - name: ExtendedGetNbConfig + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetnbconfig.md + - name: ExtendedGetNbSource + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetnbsource.md + - name: ExtendedSetSourceName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetsourcename.md + - name: ExtendedGetSourceName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetsourcename.md + - name: ExtendedSetConfigName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetconfigname.md + - name: ExtendedGetConfigName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetconfigname.md + - name: ExtendedCreateConfig + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedcreateconfig.md + - name: ExtendedSetActiveConfig + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetactiveconfig.md + - name: ExtendedSetActiveSource + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetactivesource.md + - name: ExtendedSetSourceRatio + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetsourceratio.md + - name: ExtendedGetSourceRatio + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetsourceratio.md + - name: ExtendedActivateSourceLayer + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedactivatesourcelayer.md + - name: SpectralGetActiveWavelength + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralgetactivewavelength.md + - name: SpectralGetNbWavelength + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralgetnbwavelength.md + - name: SpectralSetActiveWavelength + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralsetactivewavelength.md + - name: SpectralSpectrumChange + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralspectrumchange.md + - name: WriteSpectralTable + href: virtual_photometric_lab\extended_and_spectral_map\labvp_writespectraltable.md + - name: Color rendering index + href: virtual_photometric_lab\color_rendering_index\labvp_color_rendering_index.md + items: + - name: GetSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_getsamplecri.md + - name: SurfaceRectangleSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_surfacerectanglesamplecri.md + - name: SurfaceEllipseSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_surfaceellipsesamplecri.md + - name: SurfacePolygonSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_surfacepolygonsamplecri.md +- name: Virtual Human Vision Lab + href: virtual_human_vision_lab\labvhv_virtual_human_vision_lab.md + items: + - name: Basic methods + href: virtual_human_vision_lab\basic_methods\labvhv_basic_methods.md + items: + - name: OpenFile + href: virtual_human_vision_lab\basic_methods\labvhv_openfile.md + - name: SaveFile + href: virtual_human_vision_lab\basic_methods\labvhv_savefile.md + - name: ExportTemplate + href: virtual_human_vision_lab\basic_methods\labvhv_exporttemplate.md + - name: Map information + href: virtual_human_vision_lab\map_information\labvhv_map_information.md + items: + - name: Filename + href: virtual_human_vision_lab\map_information\labvhv_filename.md + - name: Position + href: virtual_human_vision_lab\map_information\labvhv_position.md + - name: XNb + href: virtual_human_vision_lab\map_information\labvhv_xnb.md + - name: YNb + href: virtual_human_vision_lab\map_information\labvhv_ynb.md + - name: Surface calculation on map + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surface_calculation_on_map.md + items: + - name: SurfaceLineExportTXT + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacelineexporttxt.md + - name: SurfacePolylineExportTXT + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepolylineexporttxt.md + - name: GetMagnitude + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_getmagnitude.md + - name: SetMagnitude + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_setmagnitude.md + - name: MeasuresExportTXT + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_measuresexporttxt.md + - name: SurfaceRectangleExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacerectangleexportspectrum.md + - name: SurfaceEllipseExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfaceellipseexportspectrum.md + - name: SurfaceLineExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacelineexportspectrum.md + - name: SurfacePointExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepointexportspectrum.md + - name: SurfacePolygonExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepolygonexportspectrum.md + - name: SurfacePolylineExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepolylineexportspectrum.md + - name: Exporting data + href: virtual_human_vision_lab\exporting_data\labvhv_exporting_data.md + items: + - name: AnimationLocalAdaptation + href: virtual_human_vision_lab\exporting_data\labvhv_animationlocaladaptation.md + - name: AnimationTimeAdaptation + href: virtual_human_vision_lab\exporting_data\labvhv_animationtimeadaptation.md + - name: ExportXMPtoHDRI + href: virtual_human_vision_lab\exporting_data\labvhv_exportxmptohdri.md + - name: ExportXMPImage + href: virtual_human_vision_lab\exporting_data\labvhv_exportxmpimage.md + - name: ExportXMPtoResizedImage + href: virtual_human_vision_lab\exporting_data\labvhv_exportxmptoresizedimage.md + - name: Filtering data + href: virtual_human_vision_lab\filtering_data\labvhv_filtering_data.md + items: + - name: Filtering + href: virtual_human_vision_lab\filtering_data\labvhv_filtering.md + - name: FilteringRemoveHighestPeaks + href: virtual_human_vision_lab\filtering_data\labvhv_filteringremovehighestpeaks.md + - name: Map and display option + href: virtual_human_vision_lab\map_and_display_option\labvhv_map_and_display_option.md + items: + - name: AccomodationDistance + href: virtual_human_vision_lab\map_and_display_option\labvhv_accomodationdistance.md + - name: ActivateGlare + href: virtual_human_vision_lab\map_and_display_option\labvhv_activateglare.md + - name: AdaptationType + href: virtual_human_vision_lab\map_and_display_option\labvhv_adaptationtype.md + - name: Aperture + href: virtual_human_vision_lab\map_and_display_option\labvhv_aperture.md + - name: Caption + href: virtual_human_vision_lab\map_and_display_option\labvhv_caption.md + - name: DOF + href: virtual_human_vision_lab\map_and_display_option\labvhv_dof.md + - name: Focal + href: virtual_human_vision_lab\map_and_display_option\labvhv_focal.md + - name: GamutMapping + href: virtual_human_vision_lab\map_and_display_option\labvhv_gamutmapping.md + - name: GetColor + href: virtual_human_vision_lab\map_and_display_option\labvhv_getcolor.md + - name: GetDepth + href: virtual_human_vision_lab\map_and_display_option\labvhv_getdepth.md + - name: GetPID + href: virtual_human_vision_lab\map_and_display_option\labvhv_getpid.md + - name: GetPixelListOnSurface + href: virtual_human_vision_lab\map_and_display_option\labvhv_getpixellistonsurface.md + - name: GetSelectedLayer + href: virtual_human_vision_lab\map_and_display_option\labvhv_getselectedlayer.md + - name: GetSelectedLayersUser + href: virtual_human_vision_lab\map_and_display_option\labvhv_getselectedlayersuser.md + - name: LuminanceAdaptation + href: virtual_human_vision_lab\map_and_display_option\labvhv_luminanceadaptation.md + - name: NightVisionGoggles + href: virtual_human_vision_lab\map_and_display_option\labvhv_nightvisiongoggles.md + - name: SetAutomaticGrid + href: virtual_human_vision_lab\map_and_display_option\labvhv_setautomaticgrid.md + - name: SetDisplayMode + href: virtual_human_vision_lab\map_and_display_option\labvhv_setdisplaymode.md + - name: SetGlareAlgorithm + href: virtual_human_vision_lab\map_and_display_option\labvhv_setglarealgorithm.md + - name: SetGridOrigin + href: virtual_human_vision_lab\map_and_display_option\labvhv_setgridorigin.md + - name: SetLocalAdaptationLuminanceMax + href: virtual_human_vision_lab\map_and_display_option\labvhv_setlocaladaptationluminancemax.md + - name: SetPrimaryGridSteps + href: virtual_human_vision_lab\map_and_display_option\labvhv_setprimarygridsteps.md + - name: SetSecondaryGraduationNbs + href: virtual_human_vision_lab\map_and_display_option\labvhv_setsecondarygraduationnb.md + - name: Show + href: virtual_human_vision_lab\map_and_display_option\labvhv_show.md + - name: SpectralFiltering + href: virtual_human_vision_lab\map_and_display_option\labvhv_spectralfiltering.md + - name: SpectralGetActiveWavelength + href: virtual_human_vision_lab\map_and_display_option\labvhv_spectralgetactivewavelength.md + - name: UpdateDisplayAndData + href: virtual_human_vision_lab\map_and_display_option\labvhv_updatedisplayanddata.md + - name: UpdateDisplayAndDataForVR + href: virtual_human_vision_lab\map_and_display_option\labvhv_updatedisplayanddataforvr.md + - name: VisionModeEvaluationType + href: virtual_human_vision_lab\map_and_display_option\labvhv_visionmodeevaluationtype.md + - name: ShowRuler + href: virtual_human_vision_lab\map_and_display_option\labvhv_showruler.md + - name: ShowPrimaryGrid + href: virtual_human_vision_lab\map_and_display_option\labvhv_showprimarygrid.md + - name: ShowSecondaryGrid + href: virtual_human_vision_lab\map_and_display_option\labvhv_showsecondarygrid.md + - name: SetAlwaysOnTop + href: virtual_human_vision_lab\map_and_display_option\labvhv_setalwaysontop.md + - name: Extended and spectral map + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extended_and_spectral_map.md + items: + - name: ExtendedSetSourceName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetsourcename.md + - name: ExtendedGetSourceName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetsourcename.md + - name: ExtendedSetConfigName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetconfigname.md + - name: ExtendedGetConfigName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetconfigname.md + - name: ExtendedCreateConfig + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedcreateconfig.md + - name: ExtendedGetNbConfig + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetnbconfig.md + - name: ExtendedGetNbSource + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetnbsource.md + - name: ExtendedSetActiveConfig + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetactiveconfig.md + - name: ExtendedSetActiveSource + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetactivesource.md + - name: ExtendedSetSourceRatio + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetsourceratio.md + - name: ExtendedGetSourceRatio + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetsourceratio.md + - name: ExtendedActivateSourceLayer + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedactivatesourcelayer.md + - name: SpectralGetActiveWavelength + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_spectralgetactivewavelength.md + - name: SpectralSpectrumChange + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_spectralspectrumchange.md + - name: Readability and visibility analysis + href: virtual_human_vision_lab\readability_and_visibility_analysis\labvhv_readability_and_visibility_analysis.md + items: + - name: RelativeVisualPerformanceCIE1452002 + href: virtual_human_vision_lab\readability_and_visibility_analysis\labvhv_relativevisualperformancecie1452002.md + - name: Visibility + href: virtual_human_vision_lab\readability_and_visibility_analysis\labvhv_visibility.md +- name: Virtual Reality Lab + href: virtual_reality_lab\labvr_virtual_reality_lab.md + items: + - name: Basic methods + href: virtual_reality_lab\basic_methods\labvr_basic_methods.md + items: + - name: OpenFile + href: virtual_reality_lab\basic_methods\labvr_openfile.md + - name: SaveFile + href: virtual_reality_lab\basic_methods\labvr_savefile.md + - name: Display + href: virtual_reality_lab\display\labvr_display.md + items: + - name: Show + href: virtual_reality_lab\display\labvr_show.md + - name: FullScreen + href: virtual_reality_lab\display\labvr_fullscreen.md + - name: SetAutomaticUpdate + href: virtual_reality_lab\display\labvr_setautomaticupdate.md + - name: Update + href: virtual_reality_lab\display\labvr_update.md + - name: SetAlwaysOnTop + href: virtual_reality_lab\display\labvr_setalwaysontop.md + - name: SetSightDirection + href: virtual_reality_lab\display\labvr_setsightdirection.md + - name: Sources + href: virtual_reality_lab\sources\labvr_sources.md + items: + - name: GetSourceNameExt + href: virtual_reality_lab\sources\labvr_getsourcenameext.md + - name: SetSourceName + href: virtual_reality_lab\sources\labvr_setsourcename.md + - name: GetNbSources + href: virtual_reality_lab\sources\labvr_getnbsources.md + - name: SetSourcePowerById + href: virtual_reality_lab\sources\labvr_setsourcepowerbyid.md + - name: SetSourcePowerByName + href: virtual_reality_lab\sources\labvr_setsourcepowerbyname.md + - name: SetSourceRatioById + href: virtual_reality_lab\sources\labvr_setsourceratiobyid.md + - name: SetSourceRatioByName + href: virtual_reality_lab\sources\labvr_setsourceratiobyname.md + - name: Configurations + href: virtual_reality_lab\configurations\labvr_configurations.md + items: + - name: GetNbConfigurations + href: virtual_reality_lab\configurations\labvr_getnbconfigurations.md + - name: SetConfigurationById + href: virtual_reality_lab\configurations\labvr_setconfigurationbyid.md + - name: SetConfigurationByName + href: virtual_reality_lab\configurations\labvr_setconfigurationbyname.md + - name: CreateConfig + href: virtual_reality_lab\configurations\labvr_createconfig.md + - name: GetConfigName + href: virtual_reality_lab\configurations\labvr_getconfigname.md + - name: SetConfigName + href: virtual_reality_lab\configurations\labvr_setconfigname.md + - name: Visualization mode + href: virtual_reality_lab\visualization_mode\labvr_visualization_mode.md + items: + - name: SetLeftEye + href: virtual_reality_lab\visualization_mode\labvr_setlefteye.md + - name: SetRightEye + href: virtual_reality_lab\visualization_mode\labvr_setrighteye.md + - name: SetStereoEyes + href: virtual_reality_lab\visualization_mode\labvr_setstereoeyes.md + - name: Operations on maps + href: virtual_reality_lab\operations_on_maps\labvr_operations_on_maps.md + items: + - name: OptisVRMerge + href: virtual_reality_lab\operations_on_maps\labvr_optisvrmerge.md + - name: OptisVRCombineLayers + href: virtual_reality_lab\operations_on_maps\labvr_optisvrcombinelayers.md + - name: CreateImmersiveView + href: virtual_reality_lab\operations_on_maps\labvr_createimmersiveview.md + - name: CreateObserverView + href: virtual_reality_lab\operations_on_maps\labvr_createobserverview.md + - name: Human vision + href: virtual_reality_lab\human_vision\labvr_human_vision.md + items: + - name: ActivateHumanVision + href: virtual_reality_lab\human_vision\labvr_activatehumanvision.md + - name: SetAdaptationType + href: virtual_reality_lab\human_vision\labvr_setadaptationtype.md + - name: SetLocalAdaptationLuminance + href: virtual_reality_lab\human_vision\labvr_setlocaladaptationluminance.md + - name: SetLocalAdaptationLuminanceMax + href: virtual_reality_lab\human_vision\labvr_setlocaladaptationluminancemax.md + - name: ActivateLocalAdaptationAutomatic + href: virtual_reality_lab\human_vision\labvr_activatelocaladaptationautomatic.md + - name: SetLocalAdaptationDefaultLuminance + href: virtual_reality_lab\human_vision\labvr_setlocaladaptationdefaultluminance.md + - name: ActivateTemporalAdaptation + href: virtual_reality_lab\human_vision\labvr_activatetemporaladaptation.md + - name: ActivateVisionModeEvaluationTypeAverage + href: virtual_reality_lab\human_vision\labvr_activatevisionmodeevaluationtypeaverage.md + - name: ActivateGlare + href: virtual_reality_lab\human_vision\labvr_activateglare.md + - name: SetObserverAge + href: virtual_reality_lab\human_vision\labvr_setobserverage.md + - name: HumanVisionMode + href: virtual_reality_lab\human_vision\labvr_humanvisionmode.md + - name: Exporting data + href: virtual_reality_lab\exporting_data\labvr_exporting_data.md + items: + - name: ExportCurrentViewToXMP + href: virtual_reality_lab\exporting_data\labvr_exportcurrentviewtoxmp.md + - name: ExportObserverImage + href: virtual_reality_lab\exporting_data\labvr_exportobserverimage.md + - name: ExportAllObserverImages + href: virtual_reality_lab\exporting_data\labvr_exportallobserverimages.md + - name: Other methods + href: virtual_reality_lab\other_methods\labvr_other_methods.md + items: + - name: ActivateFiltering + href: virtual_reality_lab\other_methods\labvr_activatefiltering.md + - name: SetLuminanceMax + href: virtual_reality_lab\other_methods\labvr_setluminancemax.md + - name: SetColorSpaceConversion + href: virtual_reality_lab\other_methods\labvr_setcolorspaceconversion.md + - name: SetFalseColor + href: virtual_reality_lab\other_methods\labvr_setfalsecolor.md +- name: Virtual 3D Photometric Lab + href: virtual_3d_photometric_lab\labvp3d_virtual_3d_photometric_lab.md + items: + - name: ImportTemplate + href: virtual_3d_photometric_lab\labvp3d_importtemplate.md + - name: Show + href: virtual_3d_photometric_lab\labvp3d_show.md + - name: OpenFile + href: virtual_3d_photometric_lab\labvp3d_openfile.md + - name: SaveFile + href: virtual_3d_photometric_lab\labvp3d_savefile.md + - name: Export + href: virtual_3d_photometric_lab\labvp3d_export.md + - name: GetPID + href: virtual_3d_photometric_lab\labvp3d_getpid.md + - name: FileName + href: virtual_3d_photometric_lab\labvp3d_filename.md + - name: Caption + href: virtual_3d_photometric_lab\labvp3d_caption.md + - name: ValueType + href: virtual_3d_photometric_lab\labvp3d_valuetype.md + - name: SetValueType + href: virtual_3d_photometric_lab\labvp3d_setvaluetype.md + - name: UnitType + href: virtual_3d_photometric_lab\labvp3d_unittype.md + - name: SetUnitType + href: virtual_3d_photometric_lab\labvp3d_setunittype.md + - name: SurfaceRectangleCalculation + href: virtual_3d_photometric_lab\labvp3d_surfacerectanglecalculation.md + - name: SurfaceEllipseCalculation + href: virtual_3d_photometric_lab\labvp3d_surfaceellipsecalculation.md + - name: GetNbConfig + href: virtual_3d_photometric_lab\labvp3d_getnbconfig.md + - name: GetNbSource + href: virtual_3d_photometric_lab\labvp3d_getnbsource.md + - name: GetActiveSurfaceUnit + href: virtual_3d_photometric_lab\labvp3d_getactivesurfaceunit.md + - name: SetActiveConfig + href: virtual_3d_photometric_lab\labvp3d_setactiveconfig.md + - name: SetActiveSource + href: virtual_3d_photometric_lab\labvp3d_setactivesource.md + - name: SetActiveSurfaceUnit + href: virtual_3d_photometric_lab\labvp3d_setactivesurfaceunit.md +- name: User Material Editor + href: editor_user_material\editor_user_material_user_material_editor.md + items: + - name: Basic methods + href: editor_user_material\editor_user_material_basic_methods.md + items: + - name: Filename + href: editor_user_material\editor_user_material_filename.md + - name: OpenFile + href: editor_user_material\editor_user_material_openfile.md + - name: SaveFile + href: editor_user_material\editor_user_material_savefile.md + - name: Map and display option + href: editor_user_material\editor_user_material_map_and_display_option.md + items: + - name: Caption + href: editor_user_material\editor_user_material_caption.md + - name: GetPID + href: editor_user_material\editor_user_material_getpid.md + - name: Show + href: editor_user_material\editor_user_material_show.md + - name: User concentration + href: editor_user_material\editor_user_material_user_concentration.md + items: + - name: GetUserConcentration + href: editor_user_material\editor_user_material_getuserconcentration.md + - name: SetUserConcentration + href: editor_user_material\editor_user_material_setuserconcentration.md +- name: BSDF - BRDF Anisotropic Surface Viewer + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_bsdf_brdf_anisotropic_surface_viewer.md + items: + - name: OpenFile + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_openfile.md + - name: Show + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_show.md + - name: SaveFile + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_savefile.md + - name: GetReflectionCoefficient + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_getreflectioncoefficient.md + - name: GetTransmissionCoefficient + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_gettransmissioncoefficient.md + - name: BuildBSDF180 + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_buildbsdf180.md +- name: Ray File Editor + href: editor_ray_file\editor_ray_ray_file_editor.md + items: + - name: Show + href: editor_ray_file\editor_ray_show.md + - name: OpenFile + href: editor_ray_file\editor_ray_openfile.md + - name: SaveFile + href: editor_ray_file\editor_ray_savefile.md + - name: ImportRayFile + href: editor_ray_file\editor_ray_importrayfile.md + - name: ExportRayFile + href: editor_ray_file\editor_ray_exportrayfile.md + - name: ChangeSpectrum + href: editor_ray_file\editor_ray_changespectrum.md + - name: AddRayFiles + href: editor_ray_file\editor_ray_addrayfiles.md + - name: InvertDirectionOfRay + href: editor_ray_file\editor_ray_invertdirectionofray.md + - name: RandomizeRayFile + href: editor_ray_file\editor_ray_randomizerayfile.md + - name: ProcessEnergyMax + href: editor_ray_file\editor_ray_processenergymax.md +- name: Photometric Calc + href: photometric_calc\photometric_calc_photometric_calc.md + items: + - name: AddParam + href: photometric_calc\photometric_calc_addparam.md + - name: FileResult + href: photometric_calc\photometric_calc_fileresult.md + - name: FileSource1 + href: photometric_calc\photometric_calc_filesource1.md + - name: FileSource2 + href: photometric_calc\photometric_calc_filesource2.md + - name: GetPID + href: photometric_calc\photometric_calc_getpid.md + - name: Operation + href: photometric_calc\photometric_calc_operation.md + - name: Process + href: photometric_calc\photometric_calc_process.md + - name: Show + href: photometric_calc\photometric_calc_show.md +- name: Eulumdat Viewer + href: viewer_eulumdat\viewer_eulumdat_eulumdat_viewer.md + items: + - name: Basic methods + href: viewer_eulumdat\viewer_eulumdat_basic_methods.md + items: + - name: Filename + href: viewer_eulumdat\viewer_eulumdat_filename.md + - name: OpenFile + href: viewer_eulumdat\viewer_eulumdat_openfile.md + - name: SaveFile + href: viewer_eulumdat\viewer_eulumdat_savefile.md + - name: SavePolarCurve + href: viewer_eulumdat\viewer_eulumdat_savepolarcurve.md + - name: Map and display option + href: viewer_eulumdat\viewer_eulumdat_map_and_display_option.md + items: + - name: Caption + href: viewer_eulumdat\viewer_eulumdat_caption.md + - name: GetDownwardFluxFraction + href: viewer_eulumdat\viewer_eulumdat_getdownwardfluxfraction.md + - name: GetLuminaireName + href: viewer_eulumdat\viewer_eulumdat_getluminairename.md + - name: GetNumberOfSets + href: viewer_eulumdat\viewer_eulumdat_getnumberofsets.md + - name: GetPID + href: viewer_eulumdat\viewer_eulumdat_getpid.md + - name: GetTotalLuminousFlux + href: viewer_eulumdat\viewer_eulumdat_gettotalluminousflux.md + - name: Show + href: viewer_eulumdat\viewer_eulumdat_show.md +- name: IESNA LM-63 Viewer + href: viewer_iesna_lm63\viewer_iesna_lm63_iesna_lm-63_viewer.md + items: + - name: Basic methods + href: viewer_iesna_lm63\viewer_iesna_lm63_basic_methods.md + items: + - name: Filename + href: viewer_iesna_lm63\viewer_iesna_lm63_filename.md + - name: OpenFile + href: viewer_iesna_lm63\viewer_iesna_lm63_openfile.md + - name: SaveFile + href: viewer_iesna_lm63\viewer_iesna_lm63_savefile.md + - name: SavePolarCurve + href: viewer_iesna_lm63\viewer_iesna_lm63_savepolarcurve.md + - name: XMP file export type + href: viewer_iesna_lm63\viewer_iesna_lm63_xmp_file_export_type.md + items: + - name: XmpFileExportTypeAnsysByExtent + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypeansysbyextent.md + - name: XmpFileExportTypeAnsys + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypeansys.md + - name: XmpFileExportTypeSAEAByExtent + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaeabyextent.md + - name: XmpFileExportTypeSAEA + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaea.md + - name: XmpFileExportTypeSAEBByExtent + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaebbyextent.md + - name: XmpFileExportTypeSAEB + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaeb.md + - name: XmpFileExportTypeConoscopic + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypeconoscopic.md + - name: Map and display option + href: viewer_iesna_lm63\viewer_iesna_lm63_map_and_display_option.md + items: + - name: Caption + href: viewer_iesna_lm63\viewer_iesna_lm63_caption.md + - name: GetDownwardFluxFraction + href: viewer_iesna_lm63\viewer_iesna_lm63_getdownwardfluxfraction.md + - name: GetLumenPerLamp + href: viewer_iesna_lm63\viewer_iesna_lm63_getlumenperlamp.md + - name: GetLuminaireDescription + href: viewer_iesna_lm63\viewer_iesna_lm63_getluminairedescription.md + - name: GetNumberOfLamps + href: viewer_iesna_lm63\viewer_iesna_lm63_getnumberoflamps.md + - name: GetPID + href: viewer_iesna_lm63\viewer_iesna_lm63_getpid.md + - name: Show + href: viewer_iesna_lm63\viewer_iesna_lm63_show.md diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_basic_methods.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_basic_methods.md new file mode 100644 index 0000000000..219bccfd09 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_basic_methods.md @@ -0,0 +1,6 @@ +# Basic methods + +- [Filename](viewer_eulumdat_filename.md) +- [OpenFile](viewer_eulumdat_openfile.md) +- [SaveFile](viewer_eulumdat_savefile.md) +- [SavePolarCurve](viewer_eulumdat_savepolarcurve.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_caption.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_caption.md new file mode 100644 index 0000000000..e61adc0401 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_caption.md @@ -0,0 +1,14 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object*.Caption\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_eulumdat_viewer.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_eulumdat_viewer.md new file mode 100644 index 0000000000..f2adc6cb03 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_eulumdat_viewer.md @@ -0,0 +1,48 @@ +# Eulumdat Viewer + +Automation in Eulumdat Viewer allows you to access to the data inside Eulumdat files. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the Eulumdat Viewer, +- Some HTML example files which have VB script Automation instructions. + + +All examples are given using VB Script language but any other language compatible with Automation can be used. + +## How to call the Eulumdat Viewer + +Before any call to the Human Eulumdat Viewer methods you should use the following instruction: + +``` +Set Viewer = CreateObject("EulumdatViewer.Application") +``` + +This instruction automatically runs the Eulumdat Viewer \(creates an instance of the application\). The other uses of the Eulumdat Viewer should refer to the variable *Viewer* which has been initialized with this instance. + +You could notice that there is no reference to the path where the Eulumdat Viewer is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate with **Eulumdat.Application**. + +## How to call a method + +To call a method, write *Viewer* followed by a **.** then by the name of the method and parameters between **"** and **"**, each separated by **,**. For example for opening an Eulumdat file, write the following instructions: + +``` +Dim MyVar MyVar = Viewer.OpenFile("MyEulumdat.Eulumdat") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar olds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the Eulumdat Viewer. + +All the available methods will be described below using the following syntax: + +``` +[number] return_type Method_Name(parameter 1, parameter 2,...); +``` + +with: + +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. +- Parameter n: A keyword for the type of the parameter followed by the parameter name. \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_filename.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_filename.md new file mode 100644 index 0000000000..ce79c18934 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_filename.md @@ -0,0 +1,14 @@ +# Filename + +## Description + +Gets the file name of a file. + +## Syntax + +*object*.FileName\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getdownwardfluxfraction.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getdownwardfluxfraction.md new file mode 100644 index 0000000000..bcb48ce312 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getdownwardfluxfraction.md @@ -0,0 +1,14 @@ +# GetDownwardFluxFraction + +## Description + +Gets the downward flux fraction \(DFF\). + +## Syntax + +*object*.GetDownwardFluxFraction\(\) As Double + +- *object*: Eulumdat Viewer or IES Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getluminairename.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getluminairename.md new file mode 100644 index 0000000000..8a46719e83 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getluminairename.md @@ -0,0 +1,14 @@ +# GetLuminaireName + +## Description + +Gets the luminaire name. + +## Syntax + +*object*.GetLuminaireName\(\) As String + +- *object*: Eulumdat Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getnumberofsets.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getnumberofsets.md new file mode 100644 index 0000000000..de35190415 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getnumberofsets.md @@ -0,0 +1,14 @@ +# GetNumberOfSets + +## Description + +Gets the number of standard sets of lamps. + +## Syntax + +*object*.GetNumberOfSets\(\) As Long + +- *object*: Eulumdat Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getpid.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_gettotalluminousflux.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_gettotalluminousflux.md new file mode 100644 index 0000000000..14019ff507 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_gettotalluminousflux.md @@ -0,0 +1,16 @@ +# GetTotalLuminousFlux + +## Description + +Returns the total luminous flux of set of lamps defined by its number. + +## Syntax + +*object*.GetTotalLuminousFlux\(ULONG iSet\) As Double + +- *object*: Eulumdat Viewer object + +- *iSet*: number of the set of lamps + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_map_and_display_option.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_map_and_display_option.md new file mode 100644 index 0000000000..556104f077 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_map_and_display_option.md @@ -0,0 +1,9 @@ +# Map and display option + +- [Caption](viewer_eulumdat_caption.md) +- [GetDownwardFluxFraction](viewer_eulumdat_getdownwardfluxfraction.md) +- [GetLuminaireName](viewer_eulumdat_getluminairename.md) +- [GetNumberOfSets](viewer_eulumdat_getnumberofsets.md) +- [GetPID](viewer_eulumdat_getpid.md) +- [GetTotalLuminousFlux](viewer_eulumdat_gettotalluminousflux.md) +- [Show](viewer_eulumdat_show.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_openfile.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_openfile.md new file mode 100644 index 0000000000..23aa2fb805 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_savefile.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_savefile.md new file mode 100644 index 0000000000..9109ec9e9d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_savepolarcurve.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_savepolarcurve.md new file mode 100644 index 0000000000..b9b511bb1a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_savepolarcurve.md @@ -0,0 +1,16 @@ +# SavePolarCurve + +## Description + +Saves the picture of the polar curve in a JPG file. + +## Syntax + +*object*.SavePolarCurve\(BSTR bstrPolarFileName\) + +- *object*: Eulumdat Viewer or IES Viewer object + +- *bstrPolarFileName*: JPG file name string + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_show.md b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_eulumdat/viewer_eulumdat_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_basic_methods.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_basic_methods.md new file mode 100644 index 0000000000..81c1553328 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_basic_methods.md @@ -0,0 +1,7 @@ +# Basic methods + +- [Filename](viewer_iesna_lm63_filename.md) +- [OpenFile](viewer_iesna_lm63_openfile.md) +- [SaveFile](viewer_iesna_lm63_savefile.md) +- [SavePolarCurve](viewer_iesna_lm63_savepolarcurve.md) +- [XMP file export type](viewer_iesna_lm63_xmp_file_export_type.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_caption.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_caption.md new file mode 100644 index 0000000000..e61adc0401 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_caption.md @@ -0,0 +1,14 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object*.Caption\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_filename.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_filename.md new file mode 100644 index 0000000000..ce79c18934 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_filename.md @@ -0,0 +1,14 @@ +# Filename + +## Description + +Gets the file name of a file. + +## Syntax + +*object*.FileName\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getdownwardfluxfraction.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getdownwardfluxfraction.md new file mode 100644 index 0000000000..bcb48ce312 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getdownwardfluxfraction.md @@ -0,0 +1,14 @@ +# GetDownwardFluxFraction + +## Description + +Gets the downward flux fraction \(DFF\). + +## Syntax + +*object*.GetDownwardFluxFraction\(\) As Double + +- *object*: Eulumdat Viewer or IES Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getlumenperlamp.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getlumenperlamp.md new file mode 100644 index 0000000000..b8bf1f9e87 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getlumenperlamp.md @@ -0,0 +1,14 @@ +# GetLumenPerLamp + +## Description + +Gets the lumen value per lamp. + +## Syntax + +*object*.GetLumenPerLamp\(\) As Double + +- *object*: IES Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getluminairedescription.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getluminairedescription.md new file mode 100644 index 0000000000..5d89c64419 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getluminairedescription.md @@ -0,0 +1,14 @@ +# GetLuminaireDescription + +## Description + +Gets the luminaire description. + +## Syntax + +*object*.GetLuminaireDescription\(\) As String + +- *object*: IES Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getnumberoflamps.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getnumberoflamps.md new file mode 100644 index 0000000000..f1387c0594 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getnumberoflamps.md @@ -0,0 +1,14 @@ +# GetNumberOfLamps + +## Description + +Gets the number of lamps. + +## Syntax + +*object*.GetNumberOfLamps\(\) As Long + +- *object*: IES Viewer object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getpid.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_iesna_lm-63_viewer.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_iesna_lm-63_viewer.md new file mode 100644 index 0000000000..8828b4bf32 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_iesna_lm-63_viewer.md @@ -0,0 +1,46 @@ +# IESNA LM-63 Viewer + +Automation in IESNA LM-63 viewer allows you to access to the data inside IES files. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the IESNA LM-63 viewer, +- Some HTML example files which have VB script Automation instructions. + +All examples are given using VB Script language but any other language compatible with Automation can be used. + +## How to call the IESNA LM-63 viewer + +Before any call to the IESNA LM-63 viewer methods you should use the following instruction: + +``` +Set Viewer = CreateObject("IESViewer.Application") +``` + +This instruction automatically runs the IESNA LM-63 viewer \(creates an instance of the application\). The other uses of the IESNA LM-63 viewer should refer to the variable *Viewer* which has been initialized with this instance. + +You could notice that there is no reference to the path where the IES Viewer is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate with *IES.Application*. + +## How to call a method + +To call a method, write *Viewer* followed by a **.** then by the name of the method and parameters between **"** and **"**, each separated by **,**. For example for opening an IES file, write the following instructions: + +``` +Dim MyVar MyVar = Viewer.OpenFile("MyIES.ies") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar olds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the IESNA LM-63 viewer. + +All the available methods will be described below using the following syntax: + +``` +[number] return_type Method_Name(parameter 1, parameter 2,...); +``` +with: + +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. +- Parameter n: A keyword for the type of the parameter followed by the parameter name. \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_map_and_display_option.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_map_and_display_option.md new file mode 100644 index 0000000000..e072dc2ddc --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_map_and_display_option.md @@ -0,0 +1,9 @@ +# Map and display option + +- [Caption](viewer_iesna_lm63_caption.md) +- [GetDownwardFluxFraction](viewer_iesna_lm63_getdownwardfluxfraction.md) +- [GetLumenPerLamp](viewer_iesna_lm63_getlumenperlamp.md) +- [GetLuminaireDescription](viewer_iesna_lm63_getluminairedescription.md) +- [GetNumberOfLamps](viewer_iesna_lm63_getnumberoflamps.md) +- [GetPID](viewer_iesna_lm63_getpid.md) +- [Show](viewer_iesna_lm63_show.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_openfile.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_openfile.md new file mode 100644 index 0000000000..23aa2fb805 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_savefile.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_savefile.md new file mode 100644 index 0000000000..9109ec9e9d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_savepolarcurve.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_savepolarcurve.md new file mode 100644 index 0000000000..b9b511bb1a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_savepolarcurve.md @@ -0,0 +1,16 @@ +# SavePolarCurve + +## Description + +Saves the picture of the polar curve in a JPG file. + +## Syntax + +*object*.SavePolarCurve\(BSTR bstrPolarFileName\) + +- *object*: Eulumdat Viewer or IES Viewer object + +- *bstrPolarFileName*: JPG file name string + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_show.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmp_file_export_type.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmp_file_export_type.md new file mode 100644 index 0000000000..c48e15d0a1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmp_file_export_type.md @@ -0,0 +1,23 @@ +# XMP file export type + +The following section contains 7 export methods. +- [XmpFileExportTypeAnsysByExtent](viewer_iesna_lm63_xmpfileexporttypeansysbyextent.md) +- [XmpFileExportTypeAnsys](viewer_iesna_lm63_xmpfileexporttypeansys.md) +- [XmpFileExportTypeSAEAByExtent](viewer_iesna_lm63_xmpfileexporttypesaeabyextent.md) +- [XmpFileExportTypeSAEA](viewer_iesna_lm63_xmpfileexporttypesaea.md) +- [XmpFileExportTypeSAEBByExtent](viewer_iesna_lm63_xmpfileexporttypesaebbyextent.md) +- [XmpFileExportTypeSAEB](viewer_iesna_lm63_xmpfileexporttypesaeb.md) +- [XmpFileExportTypeConoscopic](viewer_iesna_lm63_xmpfileexporttypeconoscopic.md) + +Each of these methods return the following error code: + +- 0: Succesful +- -1: Incorrect file name +- -2: Sampling must be greater or equal +- -3: XMax must be strictly higher than Xmin +- -4: YMax must be strictly higher than Ymin +- -5: Width must be strictly higher than 0 +- -6: Height must be strictly higher than 0 +- -7: Axis Theta0 and Vector Phi 0 must be orthogonal +- -8: Axis Theta0 and Vector Phi 0 must not be collinear +- -9: Unknown error \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeansys.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeansys.md new file mode 100644 index 0000000000..4bfab3d966 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeansys.md @@ -0,0 +1,49 @@ +# XmpFileExportTypeAnsys + +## Description + +Exports the current IES to a XMP file with the Optis intensity type using the size parameters. + +**Note:** The OPTIS Intensity XMP map type is in end of life as of version 2023 R2, and no longer available in the user interface + +## Syntax + +- `object.XmpFileExportTypeAnsys(LPCTSTR strFileName, const int iNbx, const int iNby , double dWidth, double dHeight, double dAxisTheta0X, double dAxisTheta0Y, double dAxisTheta0Z,double dVectorPhiOX, double dVectorPhiOY, double dVectorPhiOZ)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dWidth*: Width of the map +- *dHeight*: Height of the map +- *dAxisTheta0X*: Axis theta 0 in X +- *dAxisTheta0Y*: Axis theta 0 in Y +- *idAxisTheta0Z*: Axis theta 0 in Z +- *dVectorPhiOX*: Vector Phi 0 in X +- *dVectorPhiOY*: Vector Phi 0 in Y +- *dVectorPhiOZ*: Vector Phi 0 in Z + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeAnsys("C:\OptisMap.xmp", 100, 100, 180, 180, 0, 0, 1, 1, 0, 0)) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +# Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +# Exports to XMP +IESViewer.XmpFileExportTypeAnsys("C:\\OptisMap.xmp", 100, 100, 90, 90, 0, 0, 1, 1, 0, 0) +``` + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeansysbyextent.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeansysbyextent.md new file mode 100644 index 0000000000..461a2f7ebe --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeansysbyextent.md @@ -0,0 +1,51 @@ +# XmpFileExportTypeAnsysByExtent + +## Description + +Exports the current IES to a XMP file with the Optis intensity type. Minimum and maximum parameters are used to size the exported map. + +**Note:** The OPTIS Intensity XMP map type is in end of life as of version 2023 R2, and no longer available in the user interface + +## Syntax + +- `object.XmpFileExportTypeAnsysByExtent(LPCTSTR strFileName, const int iNbx, const int iNby , double dXmin, double dXmax, double dYmin, double dYmax, double dAxisTheta0X, double dAxisTheta0Y, double dAxisTheta0Z,double dVectorPhiOX, double dVectorPhiOY, double dVectorPhiOZ)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dXmin*: minimum position of the map in X +- *dXmax*: maximum position of the map in X +- *dYmin*: maximum position of the map in X +- *dYmax*: minimum position of the map in Y +- *dAxisTheta0X*: Axis theta 0 in X +- *dAxisTheta0Y*: Axis theta 0 in Y +- *idAxisTheta0Z*: Axis theta 0 in Z +- *dVectorPhiOX*: Vector Phi 0 in X +- *dVectorPhiOY*: Vector Phi 0 in Y +- *dVectorPhiOZ*: Vector Phi 0 in Z + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeAnsysByExtent("C:\OptisMap.xmp", 100, 100, -90, 90, -90, 90, 0, 0, 1, 1, 0, 0) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +# Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +# Exports to XMP +IESViewer.XmpFileExportTypeAnsysByExtent("C:\\OptisMap.xmp", 100, 100, -90, 90, -90, 90, 0, 0, 1, 1, 0, 0) +``` + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeconoscopic.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeconoscopic.md new file mode 100644 index 0000000000..0d6dca16b5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypeconoscopic.md @@ -0,0 +1,46 @@ +# XmpFileExportTypeConoscopic + +## Description + +Exports the current IES to a XMP file with the Conoscopic type. + +## Syntax + +- `object.XmpFileExportTypeConoscopic(LPCTSTR strFileName, const int iNbx, const int iNby , double dThetaMax, double dAxisTheta0X, double dAxisTheta0Y, double dAxisTheta0Z, double dVectorPhiOX, double dVectorPhiOY, double dVectorPhiOZ)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dThetaMax*: width of the map +- *dAxisTheta0X*: axis theta 0 in X +- *dAxisTheta0Y*: axis theta 0 in Y +- *dAxisTheta0Z*: axis theta 0 in Z +- *dVectorPhiOX*: vector Phi on X +- *dVectorPhiOY*: vector Phi on Y +- *dVectorPhiOZ*: vector Phi on Z + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeConoscopic("C:\OptisMap.xmp", 100, 100, 90, 0, 0, 1, 1, 0, 0) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +# Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +# Exports to XMP +IESViewer.XmpFileExportTypeConoscopic("C:\\OptisMap.xmp", 100, 100, 90, 0, 0, 1, 1, 0, 0) +``` + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaea.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaea.md new file mode 100644 index 0000000000..2b4a926642 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaea.md @@ -0,0 +1,41 @@ +# XmpFileExportTypeSAEA + +## Description + +Exports the current IES to a XMP file with the SAEA type using Size parameters. + +## Syntax + +- `object.XmpFileExportTypeSAEA(LPCTSTR strFileName, const int iNbx, const int iNby, double dWidth, double dHeight)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dWidth*: width of the map +- *dHeight*: height of the map + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeSAEA("C:\OptisMap.xmp", 100, 100, 180, 180) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +#Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +#Exports to XMP +IESViewer.XmpFileExportTypeSAEA("C:\\OptisMap.xmp", 100, 100, 180, 180) +``` + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaeabyextent.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaeabyextent.md new file mode 100644 index 0000000000..e9946b7ed3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaeabyextent.md @@ -0,0 +1,43 @@ +# XmpFileExportTypeSAEAByExtent + +## Description + +Exports the current IES to a XMP file with the SAEA type. Minimum and maximum parameters are used to size the exported map. + +## Syntax + +- `object.XmpFileExportTypeSAEAByExtent(LPCTSTR strFileName, const int iNbx, const int iNby ,double dXmin,double dXmax, double dYmin, double dYmax)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dXmin*: minimum position of the map in X +- *dXmax*: maximum position of the map in X +- *dYmin*: minimum position of the map in Y +- *dYmax*: maximum position of the map in Y + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeSAEAByExtent("C:\OptisMap.xmp", 100, 100, -90, 90, -90, 90)) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +# Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +# Exports to XMP +IESViewer.XmpFileExportTypeSAEAByExtent("C:\\OptisMap.xmp", 100, 100, -90, 90, -90, 90) +``` + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaeb.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaeb.md new file mode 100644 index 0000000000..6469794163 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaeb.md @@ -0,0 +1,41 @@ +# XmpFileExportTypeSAEB + +## Description + +Exports the current IES to a XMP file with the SAEB type using size parameters. + +## Syntax + +- `object.XmpFileExportTypeSAEB(LPCTSTR strFileName, const int iNbx, const int iNby , double dWidth, double dHeight)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dWidth*: width of the map +- *dHeight*: height of the map + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeSAEB("C:\OptisMap.xmp", 100, 100, 180, 180)) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +# Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +# Exports to XMP +IESViewer.XmpFileExportTypeSAEB("C:\\OptisMap.xmp", 100, 100, 180, 180) +``` + + diff --git a/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaebbyextent.md b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaebbyextent.md new file mode 100644 index 0000000000..94ab5ba8f3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/viewer_iesna_lm63/viewer_iesna_lm63_xmpfileexporttypesaebbyextent.md @@ -0,0 +1,43 @@ +# XmpFileExportTypeSAEBByExtent + +## Description + +Exports the current IES to a XMP file with the SAEB type. Minimum and maximum parameters are used to size the exported map. + +## Syntax + +- `object.XmpFileExportTypeSAEBByExtent(LPCTSTR strFileName, const int iNbx, const int iNby , double dXmin, double dXmax, double dYmin, double dYmax)` as Short +- *object*: IES Viewer +- *bstrFileName*: path and filename of the .XMP +- *iNbx*: number sampling in X +- *iNby*: number sampling in Y +- *dXmin*: minimum position of the map in X +- *dXmax*: maximum position of the map in X +- *dYmin*: minimum position of the map in Y +- *dYmax*: maximum position of the map in Y + +## VB script example + +```VB +' Creates IESViewer COM server +set IESViewer = CreateObject("IESViewer.Application") +' Opens IES file +IESViewer.OpenFile("C:\IESFile.ies") +' Set Export Xmp +IESViewer.XmpFileExportTypeSAEBByExtent("C:\OptisMap.xmp", 100, 100, -90, 90, -90, 90)) +``` + +## IronPython example + +```ironpython +from System import Type, Activator#Creates IESNA LM-63 Viewer COM server +#Creates IESNA LM-63 Viewer COM server +type = Type.GetTypeFromProgID("IESViewer.Application") +IESViewer = Activator.CreateInstance(type) +#Opens IES file +IESViewer.OpenFile("C:\\IESFile.ies") +#Exports to XMP +IESViewer.XmpFileExportTypeSAEBByExtent("C:\\OptisMap.xmp", 100, 100, -90, 90, -90, 90) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/TOC.yml b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/TOC.yml new file mode 100644 index 0000000000..f650f20b31 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/TOC.yml @@ -0,0 +1,886 @@ +- name: Introduction + href: lab_api_home.md +- name: Virtual Photometric Lab + href: virtual_photometric_lab\labvp_virtual_photometric_lab.md + items: + - name: Basic methods + href: virtual_photometric_lab\basic_methods\labvp_basic_methods.md + items: + - name: ImportTemplate + href: virtual_photometric_lab\basic_methods\labvp_importtemplate.md + - name: ExportTemplate + href: virtual_photometric_lab\basic_methods\labvp_exporttemplate.md + - name: MapType + href: virtual_photometric_lab\basic_methods\labvp_maptype.md + - name: OpenFile + href: virtual_photometric_lab\basic_methods\labvp_openfile.md + - name: ReturnUnitType + href: virtual_photometric_lab\basic_methods\labvp_returnunittype.md + - name: ReturnValueType + href: virtual_photometric_lab\basic_methods\labvp_returnvaluetype.md + - name: SaveFile + href: virtual_photometric_lab\basic_methods\labvp_savefile.md + - name: SetColorMode + href: virtual_photometric_lab\basic_methods\labvp_setcolormode.md + - name: SetReturnUnitType + href: virtual_photometric_lab\basic_methods\labvp_setreturnunittype.md + - name: UnitType + href: virtual_photometric_lab\basic_methods\labvp_unittype.md + - name: ValueType + href: virtual_photometric_lab\basic_methods\labvp_valuetype.md + - name: GetIntensityType + href: virtual_photometric_lab\basic_methods\labvp_getintensitytype.md + - name: GetAxisUnitName + href: virtual_photometric_lab\basic_methods\labvp_getaxisunitname.md + - name: GetPID + href: virtual_photometric_lab\basic_methods\labvp_getpid.md + - name: Map information + href: virtual_photometric_lab\map_information\labvp_map_information.md + items: + - name: Filename + href: virtual_photometric_lab\map_information\labvp_filename.md + - name: Position + href: virtual_photometric_lab\map_information\labvp_position.md + - name: WMax + href: virtual_photometric_lab\map_information\labvp_wmax.md + - name: WMin + href: virtual_photometric_lab\map_information\labvp_wmin.md + - name: WNb + href: virtual_photometric_lab\map_information\labvp_wnb.md + - name: WSampleWidth + href: virtual_photometric_lab\map_information\labvp_wsamplewidth.md + - name: XMax + href: virtual_photometric_lab\map_information\labvp_xmax.md + - name: XMin + href: virtual_photometric_lab\map_information\labvp_xmin.md + - name: XNb + href: virtual_photometric_lab\map_information\labvp_xnb.md + - name: XWidth + href: virtual_photometric_lab\map_information\labvp_xwidth.md + - name: XSampleWidth + href: virtual_photometric_lab\map_information\labvp_xsamplewidth.md + - name: XYZToBlackbodyTemperature + href: virtual_photometric_lab\map_information\labvp_xyztoblackbodytemperature.md + - name: YMax + href: virtual_photometric_lab\map_information\labvp_ymax.md + - name: Ymin + href: virtual_photometric_lab\map_information\labvp_ymin.md + - name: YNb + href: virtual_photometric_lab\map_information\labvp_ynb.md + - name: YHeight + href: virtual_photometric_lab\map_information\labvp_yheight.md + - name: YSampleHeight + href: virtual_photometric_lab\map_information\labvp_ysampleheight.md + - name: Get value on map + href: virtual_photometric_lab\get_value_on_map\labvp_get_value_on_map.md + items: + - name: GetColor + href: virtual_photometric_lab\get_value_on_map\labvp_getcolor.md + - name: GetColorSystemColorNames + href: virtual_photometric_lab\get_value_on_map\labvp_getcolorsystemcolornames.md + - name: GetCurrentColorSystem + href: virtual_photometric_lab\get_value_on_map\labvp_getcurrentcolorsystem.md + - name: GetGeneralCRI + href: virtual_photometric_lab\get_value_on_map\labvp_getgeneralcri.md + - name: GetPixelListOnSurface + href: virtual_photometric_lab\get_value_on_map\labvp_getpixellistonsurface.md + - name: GetPrecision + href: virtual_photometric_lab\get_value_on_map\labvp_getprecision.md + - name: GetSelectedLayer + href: virtual_photometric_lab\get_value_on_map\labvp_getselectedlayer.md + - name: GetSelectedLayersUser + href: virtual_photometric_lab\get_value_on_map\labvp_getselectedlayersuser.md + - name: GetValue + href: virtual_photometric_lab\get_value_on_map\labvp_getvalue.md + - name: GetValue1 + href: virtual_photometric_lab\get_value_on_map\labvp_getvalue1.md + - name: GetValue2 + href: virtual_photometric_lab\get_value_on_map\labvp_getvalue2.md + - name: GetValueEllipse + href: virtual_photometric_lab\get_value_on_map\labvp_getvalueellipse.md + - name: GetValueRectangle + href: virtual_photometric_lab\get_value_on_map\labvp_getvaluerectangl.md + - name: SetMinMax + href: virtual_photometric_lab\get_value_on_map\labvp_setminmax.md + - name: Surface calculation on map + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surface_calculation_on_map.md + items: + - name: SurfaceEllipseBarycentre + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsebarycentre.md + - name: SurfaceEllipseCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsecalculation.md + - name: SurfaceEllipseColor + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsecolor.md + - name: SurfaceEllipseExport + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipseexport.md + - name: SurfaceEllipseGeneralCRI + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsegeneralcri.md + - name: SurfaceEllipseSigma + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipsesigma.md + - name: SurfaceEllipseExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfaceellipseexportspectrum.md + - name: SurfaceLineCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelinecalculation.md + - name: SurfaceLineCalculation2 + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelinecalculation2.md + - name: SurfaceLineExportTXT + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelineexporttxt.md + - name: SurfaceLineExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacelineexportspectrum.md + - name: SurfacePolylineExportTXT + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolylineexporttxt.md + - name: SurfacePolylineExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolylineexportspectrum.md + - name: SurfacePolygonBarycentre + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonbarycentre.md + - name: SurfacePolygonCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygoncalculation.md + - name: SurfacePolygonColor + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygoncolor.md + - name: SurfacePolygonExport + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonexport.md + - name: SurfacePolygonGeneralCRI + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygongeneralcri.md + - name: SurfacePolygonSigma + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonsigma.md + - name: SurfacePolygonExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepolygonexportspectrum.md + - name: SurfacePointExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacepointexportspectrum.md + - name: SurfaceRectangleBarycentre + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglebarycentre.md + - name: SurfaceRectangleCalculation + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglecalculation.md + - name: SurfaceRectangleColor + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglecolor.md + - name: SurfaceRectangleExport + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectangleexport.md + - name: SurfaceRectangleGeneralCRI + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglegeneralcri.md + - name: SurfaceRectangleSigma + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectanglesigma.md + - name: SurfaceRectangleExportSpectrum + href: virtual_photometric_lab\surface_calculation_on_map\labvp_surfacerectangleexportspectrum.md + - name: SetSurfaceThresholdMax + href: virtual_photometric_lab\surface_calculation_on_map\labvp_setsurfacethresholdma.md + - name: SetSurfaceThresholdMin + href: virtual_photometric_lab\surface_calculation_on_map\labvp_setsurfacethresholdmin.md + - name: RemoveSurfaceThresholdMax + href: virtual_photometric_lab\surface_calculation_on_map\labvp_removesurfacethresholdmax.md + - name: RemoveSurfaceThresholdMin + href: virtual_photometric_lab\surface_calculation_on_map\labvp_removesurfacethresholdmin.md + - name: GetMagnitude + href: virtual_photometric_lab\surface_calculation_on_map\labvp_getmagnitude.md + - name: SetMagnitude + href: virtual_photometric_lab\surface_calculation_on_map\labvp_setmagnitude.md + - name: MeasuresExportTXT + href: virtual_photometric_lab\surface_calculation_on_map\labvp_measuresexporttxt.md + - name: Creating a new map + href: virtual_photometric_lab\create_new_map\labvp_creating_a_new_map.md + items: + - name: CreateMap + href: virtual_photometric_lab\create_new_map\labvp_createmap.md + - name: ImportTXT + href: virtual_photometric_lab\create_new_map\labvp_importtxt.md + - name: SetXMax + href: virtual_photometric_lab\create_new_map\labvp_setxmax.md + - name: SetXMin + href: virtual_photometric_lab\create_new_map\labvp_setxmin.md + - name: SetYMax + href: virtual_photometric_lab\create_new_map\labvp_setymax.md + - name: SetYMin + href: virtual_photometric_lab\create_new_map\labvp_setymin.md + - name: Exporting data + href: virtual_photometric_lab\exporting_data\labvp_exporting_data.md + items: + - name: ExportChart3D + href: virtual_photometric_lab\exporting_data\labvp_exportchart3d.md + - name: ExportChart3D3D + href: virtual_photometric_lab\exporting_data\labvp_exportchart3d3d.md + - name: ExportTXT + href: virtual_photometric_lab\exporting_data\labvp_exporttxt.md + - name: ExportPF + href: virtual_photometric_lab\exporting_data\labvp_exportpf.md + - name: ExportXMP + href: virtual_photometric_lab\exporting_data\labvp_exportxmp.md + - name: ExportXMPtoIntensity + href: virtual_photometric_lab\exporting_data\labvp_exportxmptointensity.md + - name: ExportXMPImage + href: virtual_photometric_lab\exporting_data\labvp_exportxmpimage.md + - name: ExportXMPtoResizedImage + href: virtual_photometric_lab\exporting_data\labvp_exportxmptoresizedimage.md + - name: ExportXMPIso + href: virtual_photometric_lab\exporting_data\labvp_exportxmpiso.md + - name: ExportXMPtoHDRI + href: virtual_photometric_lab\exporting_data\labvp_exportxmptohdri.md + - name: Filtering data + href: virtual_photometric_lab\filtering_data\labvp_filtering_data.md + items: + - name: Filtering + href: virtual_photometric_lab\filtering_data\labvp_filtering.md + - name: FilteringRemoveHighestPeaks + href: virtual_photometric_lab\filtering_data\labvp_filteringremovehighestpeaks.md + - name: Map and display option + href: virtual_photometric_lab\map_and_display_option\labvp_map_and_display_option.md + items: + - name: AutomaticUpdate + href: virtual_photometric_lab\map_and_display_option\labvp_automaticupdate.md + - name: AxisSymetry + href: virtual_photometric_lab\map_and_display_option\labvp_axissymetry.md + - name: Caption + href: virtual_photometric_lab\map_and_display_option\labvp_caption.md + - name: FillBackground + href: virtual_photometric_lab\map_and_display_option\labvp_fillbackground.md + - name: GetComment + href: virtual_photometric_lab\map_and_display_option\labvp_getcomment.md + - name: HorizontalFlip + href: virtual_photometric_lab\map_and_display_option\labvp_horizontalflip.md + - name: GetHorizontalFlip + href: virtual_photometric_lab\map_and_display_option\labvp_gethorizontalflip.md + - name: IsoCurves + href: virtual_photometric_lab\map_and_display_option\labvp_isocurves.md + - name: LoadScaleLevels + href: virtual_photometric_lab\map_and_display_option\labvp_loadscalelevels.md + - name: NightVisionGoggles + href: virtual_photometric_lab\map_and_display_option\labvp_nightvisiongoggles.md + - name: SaveScaleImage + href: virtual_photometric_lab\map_and_display_option\labvp_savescaleimage.md + - name: SetAlwaysOnTop + href: virtual_photometric_lab\map_and_display_option\labvp_setalwaysontop.md + - name: SetAutomaticGrid + href: virtual_photometric_lab\map_and_display_option\labvp_setautomaticgrid.md + - name: SetComment + href: virtual_photometric_lab\map_and_display_option\labvp_setcomment.md + - name: SetDisplayMode + href: virtual_photometric_lab\map_and_display_option\labvp_setdisplaymode.md + - name: SetGridOrigin + href: virtual_photometric_lab\map_and_display_option\labvp_setgridorigin.md + - name: SetPrimaryGridSteps + href: virtual_photometric_lab\map_and_display_option\labvp_setprimarygridsteps.md + - name: SetSecondaryGraduationNbs + href: virtual_photometric_lab\map_and_display_option\labvp_setsecondarygraduationnbs.md + - name: Show + href: virtual_photometric_lab\map_and_display_option\labvp_show.md + - name: ShowPrimaryGrid + href: virtual_photometric_lab\map_and_display_option\labvp_showprimarygrid.md + - name: ShowSecondaryGrid + href: virtual_photometric_lab\map_and_display_option\labvp_showsecondarygrid.md + - name: ShowRuler + href: virtual_photometric_lab\map_and_display_option\labvp_showruler.md + - name: SpectralFiltering + href: virtual_photometric_lab\map_and_display_option\labvp_spectralfiltering.md + - name: UpdateDisplayAndData + href: virtual_photometric_lab\map_and_display_option\labvp_updatedisplayanddata.md + - name: SetLogScale + href: virtual_photometric_lab\map_and_display_option\labvp_setlogscale.md + - name: Extended and spectral map + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extended_and_spectral_map.md + items: + - name: ExtendedExportTXT + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedexporttxt.md + - name: ExtendedGetNbConfig + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetnbconfig.md + - name: ExtendedGetNbSource + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetnbsource.md + - name: ExtendedSetSourceName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetsourcename.md + - name: ExtendedGetSourceName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetsourcename.md + - name: ExtendedSetConfigName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetconfigname.md + - name: ExtendedGetConfigName + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetconfigname.md + - name: ExtendedCreateConfig + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedcreateconfig.md + - name: ExtendedSetActiveConfig + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetactiveconfig.md + - name: ExtendedSetActiveSource + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetactivesource.md + - name: ExtendedSetSourceRatio + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedsetsourceratio.md + - name: ExtendedGetSourceRatio + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedgetsourceratio.md + - name: ExtendedActivateSourceLayer + href: virtual_photometric_lab\extended_and_spectral_map\labvp_extendedactivatesourcelayer.md + - name: SpectralGetActiveWavelength + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralgetactivewavelength.md + - name: SpectralGetNbWavelength + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralgetnbwavelength.md + - name: SpectralSetActiveWavelength + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralsetactivewavelength.md + - name: SpectralSpectrumChange + href: virtual_photometric_lab\extended_and_spectral_map\labvp_spectralspectrumchange.md + - name: WriteSpectralTable + href: virtual_photometric_lab\extended_and_spectral_map\labvp_writespectraltable.md + - name: Color rendering index + href: virtual_photometric_lab\color_rendering_index\labvp_color_rendering_index.md + items: + - name: GetSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_getsamplecri.md + - name: SurfaceRectangleSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_surfacerectanglesamplecri.md + - name: SurfaceEllipseSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_surfaceellipsesamplecri.md + - name: SurfacePolygonSampleCRI + href: virtual_photometric_lab\color_rendering_index\labvp_surfacepolygonsamplecri.md +- name: Virtual Human Vision Lab + href: virtual_human_vision_lab\labvhv_virtual_human_vision_lab.md + items: + - name: Basic methods + href: virtual_human_vision_lab\basic_methods\labvhv_basic_methods.md + items: + - name: OpenFile + href: virtual_human_vision_lab\basic_methods\labvhv_openfile.md + - name: SaveFile + href: virtual_human_vision_lab\basic_methods\labvhv_savefile.md + - name: ExportTemplate + href: virtual_human_vision_lab\basic_methods\labvhv_exporttemplate.md + - name: Map information + href: virtual_human_vision_lab\map_information\labvhv_map_information.md + items: + - name: Filename + href: virtual_human_vision_lab\map_information\labvhv_filename.md + - name: Position + href: virtual_human_vision_lab\map_information\labvhv_position.md + - name: XNb + href: virtual_human_vision_lab\map_information\labvhv_xnb.md + - name: YNb + href: virtual_human_vision_lab\map_information\labvhv_ynb.md + - name: Surface calculation on map + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surface_calculation_on_map.md + items: + - name: SurfaceLineExportTXT + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacelineexporttxt.md + - name: SurfacePolylineExportTXT + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepolylineexporttxt.md + - name: GetMagnitude + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_getmagnitude.md + - name: SetMagnitude + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_setmagnitude.md + - name: MeasuresExportTXT + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_measuresexporttxt.md + - name: SurfaceRectangleExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacerectangleexportspectrum.md + - name: SurfaceEllipseExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfaceellipseexportspectrum.md + - name: SurfaceLineExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacelineexportspectrum.md + - name: SurfacePointExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepointexportspectrum.md + - name: SurfacePolygonExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepolygonexportspectrum.md + - name: SurfacePolylineExportSpectrum + href: virtual_human_vision_lab\surface_calculation_on_map\labvhv_surfacepolylineexportspectrum.md + - name: Exporting data + href: virtual_human_vision_lab\exporting_data\labvhv_exporting_data.md + items: + - name: AnimationLocalAdaptation + href: virtual_human_vision_lab\exporting_data\labvhv_animationlocaladaptation.md + - name: AnimationTimeAdaptation + href: virtual_human_vision_lab\exporting_data\labvhv_animationtimeadaptation.md + - name: ExportXMPtoHDRI + href: virtual_human_vision_lab\exporting_data\labvhv_exportxmptohdri.md + - name: ExportXMPImage + href: virtual_human_vision_lab\exporting_data\labvhv_exportxmpimage.md + - name: ExportXMPtoResizedImage + href: virtual_human_vision_lab\exporting_data\labvhv_exportxmptoresizedimage.md + - name: Filtering data + href: virtual_human_vision_lab\filtering_data\labvhv_filtering_data.md + items: + - name: Filtering + href: virtual_human_vision_lab\filtering_data\labvhv_filtering.md + - name: FilteringRemoveHighestPeaks + href: virtual_human_vision_lab\filtering_data\labvhv_filteringremovehighestpeaks.md + - name: Map and display option + href: virtual_human_vision_lab\map_and_display_option\labvhv_map_and_display_option.md + items: + - name: AccomodationDistance + href: virtual_human_vision_lab\map_and_display_option\labvhv_accomodationdistance.md + - name: ActivateGlare + href: virtual_human_vision_lab\map_and_display_option\labvhv_activateglare.md + - name: AdaptationType + href: virtual_human_vision_lab\map_and_display_option\labvhv_adaptationtype.md + - name: Aperture + href: virtual_human_vision_lab\map_and_display_option\labvhv_aperture.md + - name: Caption + href: virtual_human_vision_lab\map_and_display_option\labvhv_caption.md + - name: DOF + href: virtual_human_vision_lab\map_and_display_option\labvhv_dof.md + - name: Focal + href: virtual_human_vision_lab\map_and_display_option\labvhv_focal.md + - name: GamutMapping + href: virtual_human_vision_lab\map_and_display_option\labvhv_gamutmapping.md + - name: GetColor + href: virtual_human_vision_lab\map_and_display_option\labvhv_getcolor.md + - name: GetDepth + href: virtual_human_vision_lab\map_and_display_option\labvhv_getdepth.md + - name: GetPID + href: virtual_human_vision_lab\map_and_display_option\labvhv_getpid.md + - name: GetPixelListOnSurface + href: virtual_human_vision_lab\map_and_display_option\labvhv_getpixellistonsurface.md + - name: GetSelectedLayer + href: virtual_human_vision_lab\map_and_display_option\labvhv_getselectedlayer.md + - name: GetSelectedLayersUser + href: virtual_human_vision_lab\map_and_display_option\labvhv_getselectedlayersuser.md + - name: LuminanceAdaptation + href: virtual_human_vision_lab\map_and_display_option\labvhv_luminanceadaptation.md + - name: NightVisionGoggles + href: virtual_human_vision_lab\map_and_display_option\labvhv_nightvisiongoggles.md + - name: SetAutomaticGrid + href: virtual_human_vision_lab\map_and_display_option\labvhv_setautomaticgrid.md + - name: SetDisplayMode + href: virtual_human_vision_lab\map_and_display_option\labvhv_setdisplaymode.md + - name: SetGlareAlgorithm + href: virtual_human_vision_lab\map_and_display_option\labvhv_setglarealgorithm.md + - name: SetGridOrigin + href: virtual_human_vision_lab\map_and_display_option\labvhv_setgridorigin.md + - name: SetLocalAdaptationLuminanceMax + href: virtual_human_vision_lab\map_and_display_option\labvhv_setlocaladaptationluminancemax.md + - name: SetPrimaryGridSteps + href: virtual_human_vision_lab\map_and_display_option\labvhv_setprimarygridsteps.md + - name: SetSecondaryGraduationNbs + href: virtual_human_vision_lab\map_and_display_option\labvhv_setsecondarygraduationnb.md + - name: Show + href: virtual_human_vision_lab\map_and_display_option\labvhv_show.md + - name: SpectralFiltering + href: virtual_human_vision_lab\map_and_display_option\labvhv_spectralfiltering.md + - name: SpectralGetActiveWavelength + href: virtual_human_vision_lab\map_and_display_option\labvhv_spectralgetactivewavelength.md + - name: UpdateDisplayAndData + href: virtual_human_vision_lab\map_and_display_option\labvhv_updatedisplayanddata.md + - name: UpdateDisplayAndDataForVR + href: virtual_human_vision_lab\map_and_display_option\labvhv_updatedisplayanddataforvr.md + - name: VisionModeEvaluationType + href: virtual_human_vision_lab\map_and_display_option\labvhv_visionmodeevaluationtype.md + - name: ShowRuler + href: virtual_human_vision_lab\map_and_display_option\labvhv_showruler.md + - name: ShowPrimaryGrid + href: virtual_human_vision_lab\map_and_display_option\labvhv_showprimarygrid.md + - name: ShowSecondaryGrid + href: virtual_human_vision_lab\map_and_display_option\labvhv_showsecondarygrid.md + - name: SetAlwaysOnTop + href: virtual_human_vision_lab\map_and_display_option\labvhv_setalwaysontop.md + - name: Extended and spectral map + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extended_and_spectral_map.md + items: + - name: ExtendedSetSourceName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetsourcename.md + - name: ExtendedGetSourceName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetsourcename.md + - name: ExtendedSetConfigName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetconfigname.md + - name: ExtendedGetConfigName + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetconfigname.md + - name: ExtendedCreateConfig + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedcreateconfig.md + - name: ExtendedGetNbConfig + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetnbconfig.md + - name: ExtendedGetNbSource + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetnbsource.md + - name: ExtendedSetActiveConfig + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetactiveconfig.md + - name: ExtendedSetActiveSource + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetactivesource.md + - name: ExtendedSetSourceRatio + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedsetsourceratio.md + - name: ExtendedGetSourceRatio + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedgetsourceratio.md + - name: ExtendedActivateSourceLayer + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_extendedactivatesourcelayer.md + - name: SpectralGetActiveWavelength + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_spectralgetactivewavelength.md + - name: SpectralSpectrumChange + href: virtual_human_vision_lab\extended_and_spectral_map\labvhv_spectralspectrumchange.md + - name: Readability and visibility analysis + href: virtual_human_vision_lab\readability_and_visibility_analysis\labvhv_readability_and_visibility_analysis.md + items: + - name: RelativeVisualPerformanceCIE1452002 + href: virtual_human_vision_lab\readability_and_visibility_analysis\labvhv_relativevisualperformancecie1452002.md + - name: Visibility + href: virtual_human_vision_lab\readability_and_visibility_analysis\labvhv_visibility.md +- name: Virtual Reality Lab + href: virtual_reality_lab\labvr_virtual_reality_lab.md + items: + - name: Basic methods + href: virtual_reality_lab\basic_methods\labvr_basic_methods.md + items: + - name: OpenFile + href: virtual_reality_lab\basic_methods\labvr_openfile.md + - name: SaveFile + href: virtual_reality_lab\basic_methods\labvr_savefile.md + - name: Display + href: virtual_reality_lab\display\labvr_display.md + items: + - name: Show + href: virtual_reality_lab\display\labvr_show.md + - name: FullScreen + href: virtual_reality_lab\display\labvr_fullscreen.md + - name: SetAutomaticUpdate + href: virtual_reality_lab\display\labvr_setautomaticupdate.md + - name: Update + href: virtual_reality_lab\display\labvr_update.md + - name: SetAlwaysOnTop + href: virtual_reality_lab\display\labvr_setalwaysontop.md + - name: SetSightDirection + href: virtual_reality_lab\display\labvr_setsightdirection.md + - name: Sources + href: virtual_reality_lab\sources\labvr_sources.md + items: + - name: GetSourceNameExt + href: virtual_reality_lab\sources\labvr_getsourcenameext.md + - name: SetSourceName + href: virtual_reality_lab\sources\labvr_setsourcename.md + - name: GetNbSources + href: virtual_reality_lab\sources\labvr_getnbsources.md + - name: SetSourcePowerById + href: virtual_reality_lab\sources\labvr_setsourcepowerbyid.md + - name: SetSourcePowerByName + href: virtual_reality_lab\sources\labvr_setsourcepowerbyname.md + - name: SetSourceRatioById + href: virtual_reality_lab\sources\labvr_setsourceratiobyid.md + - name: SetSourceRatioByName + href: virtual_reality_lab\sources\labvr_setsourceratiobyname.md + - name: Configurations + href: virtual_reality_lab\configurations\labvr_configurations.md + items: + - name: GetNbConfigurations + href: virtual_reality_lab\configurations\labvr_getnbconfigurations.md + - name: SetConfigurationById + href: virtual_reality_lab\configurations\labvr_setconfigurationbyid.md + - name: SetConfigurationByName + href: virtual_reality_lab\configurations\labvr_setconfigurationbyname.md + - name: CreateConfig + href: virtual_reality_lab\configurations\labvr_createconfig.md + - name: GetConfigName + href: virtual_reality_lab\configurations\labvr_getconfigname.md + - name: SetConfigName + href: virtual_reality_lab\configurations\labvr_setconfigname.md + - name: Visualization mode + href: virtual_reality_lab\visualization_mode\labvr_visualization_mode.md + items: + - name: SetLeftEye + href: virtual_reality_lab\visualization_mode\labvr_setlefteye.md + - name: SetRightEye + href: virtual_reality_lab\visualization_mode\labvr_setrighteye.md + - name: SetStereoEyes + href: virtual_reality_lab\visualization_mode\labvr_setstereoeyes.md + - name: Operations on maps + href: virtual_reality_lab\operations_on_maps\labvr_operations_on_maps.md + items: + - name: OptisVRMerge + href: virtual_reality_lab\operations_on_maps\labvr_optisvrmerge.md + - name: OptisVRCombineLayers + href: virtual_reality_lab\operations_on_maps\labvr_optisvrcombinelayers.md + - name: CreateImmersiveView + href: virtual_reality_lab\operations_on_maps\labvr_createimmersiveview.md + - name: CreateObserverView + href: virtual_reality_lab\operations_on_maps\labvr_createobserverview.md + - name: Human vision + href: virtual_reality_lab\human_vision\labvr_human_vision.md + items: + - name: ActivateHumanVision + href: virtual_reality_lab\human_vision\labvr_activatehumanvision.md + - name: SetAdaptationType + href: virtual_reality_lab\human_vision\labvr_setadaptationtype.md + - name: SetLocalAdaptationLuminance + href: virtual_reality_lab\human_vision\labvr_setlocaladaptationluminance.md + - name: SetLocalAdaptationLuminanceMax + href: virtual_reality_lab\human_vision\labvr_setlocaladaptationluminancemax.md + - name: ActivateLocalAdaptationAutomatic + href: virtual_reality_lab\human_vision\labvr_activatelocaladaptationautomatic.md + - name: SetLocalAdaptationDefaultLuminance + href: virtual_reality_lab\human_vision\labvr_setlocaladaptationdefaultluminance.md + - name: ActivateTemporalAdaptation + href: virtual_reality_lab\human_vision\labvr_activatetemporaladaptation.md + - name: ActivateVisionModeEvaluationTypeAverage + href: virtual_reality_lab\human_vision\labvr_activatevisionmodeevaluationtypeaverage.md + - name: ActivateGlare + href: virtual_reality_lab\human_vision\labvr_activateglare.md + - name: SetObserverAge + href: virtual_reality_lab\human_vision\labvr_setobserverage.md + - name: HumanVisionMode + href: virtual_reality_lab\human_vision\labvr_humanvisionmode.md + - name: Exporting data + href: virtual_reality_lab\exporting_data\labvr_exporting_data.md + items: + - name: ExportCurrentViewToXMP + href: virtual_reality_lab\exporting_data\labvr_exportcurrentviewtoxmp.md + - name: ExportObserverImage + href: virtual_reality_lab\exporting_data\labvr_exportobserverimage.md + - name: ExportAllObserverImages + href: virtual_reality_lab\exporting_data\labvr_exportallobserverimages.md + - name: Other methods + href: virtual_reality_lab\other_methods\labvr_other_methods.md + items: + - name: ActivateFiltering + href: virtual_reality_lab\other_methods\labvr_activatefiltering.md + - name: SetLuminanceMax + href: virtual_reality_lab\other_methods\labvr_setluminancemax.md + - name: SetColorSpaceConversion + href: virtual_reality_lab\other_methods\labvr_setcolorspaceconversion.md + - name: SetFalseColor + href: virtual_reality_lab\other_methods\labvr_setfalsecolor.md +- name: Virtual 3D Photometric Lab + href: virtual_3d_photometric_lab\labvp3d_virtual_3d_photometric_lab.md + items: + - name: ImportTemplate + href: virtual_3d_photometric_lab\labvp3d_importtemplate.md + - name: Show + href: virtual_3d_photometric_lab\labvp3d_show.md + - name: OpenFile + href: virtual_3d_photometric_lab\labvp3d_openfile.md + - name: SaveFile + href: virtual_3d_photometric_lab\labvp3d_savefile.md + - name: Export + href: virtual_3d_photometric_lab\labvp3d_export.md + - name: GetPID + href: virtual_3d_photometric_lab\labvp3d_getpid.md + - name: FileName + href: virtual_3d_photometric_lab\labvp3d_filename.md + - name: Caption + href: virtual_3d_photometric_lab\labvp3d_caption.md + - name: ValueType + href: virtual_3d_photometric_lab\labvp3d_valuetype.md + - name: SetValueType + href: virtual_3d_photometric_lab\labvp3d_setvaluetype.md + - name: UnitType + href: virtual_3d_photometric_lab\labvp3d_unittype.md + - name: SetUnitType + href: virtual_3d_photometric_lab\labvp3d_setunittype.md + - name: SurfaceRectangleCalculation + href: virtual_3d_photometric_lab\labvp3d_surfacerectanglecalculation.md + - name: SurfaceEllipseCalculation + href: virtual_3d_photometric_lab\labvp3d_surfaceellipsecalculation.md + - name: GetNbConfig + href: virtual_3d_photometric_lab\labvp3d_getnbconfig.md + - name: GetNbSource + href: virtual_3d_photometric_lab\labvp3d_getnbsource.md + - name: GetActiveSurfaceUnit + href: virtual_3d_photometric_lab\labvp3d_getactivesurfaceunit.md + - name: SetActiveConfig + href: virtual_3d_photometric_lab\labvp3d_setactiveconfig.md + - name: SetActiveSource + href: virtual_3d_photometric_lab\labvp3d_setactivesource.md + - name: SetActiveSurfaceUnit + href: virtual_3d_photometric_lab\labvp3d_setactivesurfaceunit.md +- name: 3D Energy Density Lab + href: virtual_3d_energy_density_lab\lab3ded_virtual_3d_energy_density_lab.md + items: + - name: Show + href: virtual_3d_energy_density_lab\lab3ded_show.md + - name: OpenFile + href: virtual_3d_energy_density_lab\lab3ded_openfile.md + - name: SaveFile + href: virtual_3d_energy_density_lab\lab3ded_savefile.md + - name: ImportTTXT + href: virtual_3d_energy_density_lab\lab3ded_importtxt.md + - name: ExportTXT + href: virtual_3d_energy_density_lab\lab3ded_exporttxt.md + - name: GetPID + href: virtual_3d_energy_density_lab\lab3ded_getpid.md + - name: FileName + href: virtual_3d_energy_density_lab\lab3ded_filename.md + - name: Caption + href: virtual_3d_energy_density_lab\lab3ded_caption.md + - name: MapType + href: virtual_3d_energy_density_lab\lab3ded_maptype.md + - name: ValueType + href: virtual_3d_energy_density_lab\lab3ded_valuetype.md + - name: UnitType + href: virtual_3d_energy_density_lab\lab3ded_unittype.md + - name: Filtering + href: virtual_3d_energy_density_lab\lab3ded_filtering.md + - name: XMax + href: virtual_3d_energy_density_lab\lab3ded_xmax.md + - name: XMin + href: virtual_3d_energy_density_lab\lab3ded_xmin.md + - name: XNb + href: virtual_3d_energy_density_lab\lab3ded_xnb.md + - name: XWidth + href: virtual_3d_energy_density_lab\lab3ded_xwidth.md + - name: XSampleWidth + href: virtual_3d_energy_density_lab\lab3ded_xsamplewidth.md + - name: YMax + href: virtual_3d_energy_density_lab\lab3ded_ymax.md + - name: YMin + href: virtual_3d_energy_density_lab\lab3ded_ymin.md + - name: YNb + href: virtual_3d_energy_density_lab\lab3ded_ynb.md + - name: YHeight + href: virtual_3d_energy_density_lab\lab3ded_yheight.md + - name: YSampleHeight + href: virtual_3d_energy_density_lab\lab3ded_ysampleheight.md + - name: ZMax + href: virtual_3d_energy_density_lab\lab3ded_zmax.md + - name: ZMin + href: virtual_3d_energy_density_lab\lab3ded_zmin.md + - name: ZNb + href: virtual_3d_energy_density_lab\lab3ded_znb.md + - name: ZDepth + href: virtual_3d_energy_density_lab\lab3ded_zdepth.md + - name: ZSampleDepth + href: virtual_3d_energy_density_lab\lab3ded_zsampledepth.md +- name: User Material Editor + href: editor_user_material\editor_user_material_user_material_editor.md + items: + - name: Basic methods + href: editor_user_material\editor_user_material_basic_methods.md + items: + - name: Filename + href: editor_user_material\editor_user_material_filename.md + - name: OpenFile + href: editor_user_material\editor_user_material_openfile.md + - name: SaveFile + href: editor_user_material\editor_user_material_savefile.md + - name: Map and display option + href: editor_user_material\editor_user_material_map_and_display_option.md + items: + - name: Caption + href: editor_user_material\editor_user_material_caption.md + - name: GetPID + href: editor_user_material\editor_user_material_getpid.md + - name: Show + href: editor_user_material\editor_user_material_show.md + - name: User concentration + href: editor_user_material\editor_user_material_user_concentration.md + items: + - name: GetUserConcentration + href: editor_user_material\editor_user_material_getuserconcentration.md + - name: SetUserConcentration + href: editor_user_material\editor_user_material_setuserconcentration.md +- name: BSDF - BRDF Anisotropic Surface Viewer + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_bsdf_brdf_anisotropic_surface_viewer.md + items: + - name: OpenFile + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_openfile.md + - name: Show + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_show.md + - name: SaveFile + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_savefile.md + - name: GetReflectionCoefficient + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_getreflectioncoefficient.md + - name: GetTransmissionCoefficient + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_gettransmissioncoefficient.md + - name: BuildBSDF180 + href: editor_bsdf_brdf_anisotropic_surface\editor_bsdf_buildbsdf180.md +- name: Ray File Editor + href: editor_ray_file\editor_ray_ray_file_editor.md + items: + - name: Show + href: editor_ray_file\editor_ray_show.md + - name: OpenFile + href: editor_ray_file\editor_ray_openfile.md + - name: SaveFile + href: editor_ray_file\editor_ray_savefile.md + - name: ImportRayFile + href: editor_ray_file\editor_ray_importrayfile.md + - name: ExportRayFile + href: editor_ray_file\editor_ray_exportrayfile.md + - name: ChangeSpectrum + href: editor_ray_file\editor_ray_changespectrum.md + - name: AddRayFiles + href: editor_ray_file\editor_ray_addrayfiles.md + - name: InvertDirectionOfRay + href: editor_ray_file\editor_ray_invertdirectionofray.md + - name: RandomizeRayFile + href: editor_ray_file\editor_ray_randomizerayfile.md + - name: ProcessEnergyMax + href: editor_ray_file\editor_ray_processenergymax.md +- name: Photometric Calc + href: photometric_calc\photometric_calc_photometric_calc.md + items: + - name: AddParam + href: photometric_calc\photometric_calc_addparam.md + - name: FileResult + href: photometric_calc\photometric_calc_fileresult.md + - name: FileSource1 + href: photometric_calc\photometric_calc_filesource1.md + - name: FileSource2 + href: photometric_calc\photometric_calc_filesource2.md + - name: GetPID + href: photometric_calc\photometric_calc_getpid.md + - name: Operation + href: photometric_calc\photometric_calc_operation.md + - name: Process + href: photometric_calc\photometric_calc_process.md + - name: Show + href: photometric_calc\photometric_calc_show.md +- name: Eulumdat Viewer + href: viewer_eulumdat\viewer_eulumdat_eulumdat_viewer.md + items: + - name: Basic methods + href: viewer_eulumdat\viewer_eulumdat_basic_methods.md + items: + - name: Filename + href: viewer_eulumdat\viewer_eulumdat_filename.md + - name: OpenFile + href: viewer_eulumdat\viewer_eulumdat_openfile.md + - name: SaveFile + href: viewer_eulumdat\viewer_eulumdat_savefile.md + - name: SavePolarCurve + href: viewer_eulumdat\viewer_eulumdat_savepolarcurve.md + - name: Map and display option + href: viewer_eulumdat\viewer_eulumdat_map_and_display_option.md + items: + - name: Caption + href: viewer_eulumdat\viewer_eulumdat_caption.md + - name: GetDownwardFluxFraction + href: viewer_eulumdat\viewer_eulumdat_getdownwardfluxfraction.md + - name: GetLuminaireName + href: viewer_eulumdat\viewer_eulumdat_getluminairename.md + - name: GetNumberOfSets + href: viewer_eulumdat\viewer_eulumdat_getnumberofsets.md + - name: GetPID + href: viewer_eulumdat\viewer_eulumdat_getpid.md + - name: GetTotalLuminousFlux + href: viewer_eulumdat\viewer_eulumdat_gettotalluminousflux.md + - name: Show + href: viewer_eulumdat\viewer_eulumdat_show.md +- name: IESNA LM-63 Viewer + href: viewer_iesna_lm63\viewer_iesna_lm63_iesna_lm-63_viewer.md + items: + - name: Basic methods + href: viewer_iesna_lm63\viewer_iesna_lm63_basic_methods.md + items: + - name: Filename + href: viewer_iesna_lm63\viewer_iesna_lm63_filename.md + - name: OpenFile + href: viewer_iesna_lm63\viewer_iesna_lm63_openfile.md + - name: SaveFile + href: viewer_iesna_lm63\viewer_iesna_lm63_savefile.md + - name: SavePolarCurve + href: viewer_iesna_lm63\viewer_iesna_lm63_savepolarcurve.md + - name: XMP file export type + href: viewer_iesna_lm63\viewer_iesna_lm63_xmp_file_export_type.md + items: + - name: XmpFileExportTypeAnsysByExtent + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypeansysbyextent.md + - name: XmpFileExportTypeAnsys + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypeansys.md + - name: XmpFileExportTypeSAEAByExtent + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaeabyextent.md + - name: XmpFileExportTypeSAEA + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaea.md + - name: XmpFileExportTypeSAEBByExtent + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaebbyextent.md + - name: XmpFileExportTypeSAEB + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypesaeb.md + - name: XmpFileExportTypeConoscopic + href: viewer_iesna_lm63\viewer_iesna_lm63_xmpfileexporttypeconoscopic.md + - name: Map and display option + href: viewer_iesna_lm63\viewer_iesna_lm63_map_and_display_option.md + items: + - name: Caption + href: viewer_iesna_lm63\viewer_iesna_lm63_caption.md + - name: GetDownwardFluxFraction + href: viewer_iesna_lm63\viewer_iesna_lm63_getdownwardfluxfraction.md + - name: GetLumenPerLamp + href: viewer_iesna_lm63\viewer_iesna_lm63_getlumenperlamp.md + - name: GetLuminaireDescription + href: viewer_iesna_lm63\viewer_iesna_lm63_getluminairedescription.md + - name: GetNumberOfLamps + href: viewer_iesna_lm63\viewer_iesna_lm63_getnumberoflamps.md + - name: GetPID + href: viewer_iesna_lm63\viewer_iesna_lm63_getpid.md + - name: Show + href: viewer_iesna_lm63\viewer_iesna_lm63_show.md diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_caption.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_caption.md new file mode 100644 index 0000000000..76ecef7aef --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_caption.md @@ -0,0 +1,11 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object*.Caption\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_exporttxt.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_exporttxt.md new file mode 100644 index 0000000000..4786312a09 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_exporttxt.md @@ -0,0 +1,12 @@ +# ExportTXT + +## Description + +Saves the map data in a Text file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportTXT\(BSTR bstrFileName\) As Integer + +- *object*: 3D Energy Density Lab object +- *bstrFileName*: filename to save the image \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_filename.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_filename.md new file mode 100644 index 0000000000..9f69087be4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_filename.md @@ -0,0 +1,11 @@ +# Filename + +## Description + +Gets the filename of a file. + +## Syntax + +*object*.FileName\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_filtering.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_filtering.md new file mode 100644 index 0000000000..4e3d2aa8c6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_filtering.md @@ -0,0 +1,13 @@ +# Filtering + +## Description + +Applies the filtering on the map data. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.Filtering\(int iNbPasses\) As Integer + +- *object*: Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object + +- *iNbPasses*: filtering level \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_getpid.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_getpid.md new file mode 100644 index 0000000000..be1a9346b2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_getpid.md @@ -0,0 +1,11 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_importtxt.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_importtxt.md new file mode 100644 index 0000000000..0a77673fcd --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_importtxt.md @@ -0,0 +1,13 @@ +# ImportTXT + +## Description + +Imports the text file and returns 1 if the call succeeds, 0 otherwise. + +## Syntax + +*object*.ImportTXT\(BSTR bstrFileName\) As Integer + +- *object*: 3D Energy Density Lab object + +- *bstrFileName*: text filename \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_maptype.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_maptype.md new file mode 100644 index 0000000000..3333389483 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_maptype.md @@ -0,0 +1,29 @@ +# MapType + +## Description + +Gets the type of map. + +## Syntax + +*object*.MapType\(\) As Long + +- *object*: 3D Energy Density Lab object + +- Returned value: + + 0 : OptisMapTypeBasic + + 1 : OptisMapTypeLaser + + 2 : OptisMapTypeSpectral + + 3 : OptisMapTypeExtended + + 4 : OptisMapTypeUnknown + + 5 : OptisMapTypeGainMatrix + + 6 : OptisMapTypeRays + + 7 : OptisMapTypeFTM \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_openfile.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_openfile.md new file mode 100644 index 0000000000..bced414147 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_openfile.md @@ -0,0 +1,13 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Integer + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object + +- *bstrFileName*: filename string including path \(input\) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_savefile.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_savefile.md new file mode 100644 index 0000000000..ab7ce078a2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_savefile.md @@ -0,0 +1,13 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Integer + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object + +- *bstrFileName*: filename string \(input\) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_show.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_show.md new file mode 100644 index 0000000000..86eb7ad7d9 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_show.md @@ -0,0 +1,13 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Integer + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab, 3D Energy Density Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_unittype.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_unittype.md new file mode 100644 index 0000000000..7fc1affedd --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_unittype.md @@ -0,0 +1,17 @@ +# UnitType + +## Description + +Gets the unit type of the map data. + +## Syntax + +*object*.UnitType\(\) As Long + +- *object*: 3D Energy Density Lab object + +- Returned value: + + 0: OptisUnitTypeRadiometric + + 1: OptisUnitTypePhotometric \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_valuetype.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_valuetype.md new file mode 100644 index 0000000000..7e193521cc --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_valuetype.md @@ -0,0 +1,53 @@ +# ValueType + +## Description + +Gets the value type of the map data. + +## Syntax + +*object*.ValueType\(\) As Short + +- *object*: 3D Energy Density Lab object + +- Returned value: + + 0: OptisValueTypeIrradiance + + 1: OptisValueTypeIntensity + + 2: OptisValueTypeRadiance + + 3: OptisValueTypeVisual + + 4: OptisValueTypeSel + + 5: OptisValueTypeLaserPhase + + 6: OptisValueTypeLaserPhasePlane + + 7: OptisValueTypeDirectionalIrradiance + + 8: OptisValueTypeGain + + 9: OptisValueTypeWaveFront + + 10: OptisValueTypeFTM + + 11: OptisValueTypeRP + + 12: OptisValueTypePowerDensity + + 13: OptisValueTypePopulation + + 14: OptisValueTypeTemperature + + 15: OptisValueTypeAngle + + 16: OptisValueTypeCurvature + + 17: OptisValueTypeCurvatureProduct + + 18: OptisValueTypePercentage + + 19: OptisValueTypeUnknown \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_virtual_3d_energy_density_lab.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_virtual_3d_energy_density_lab.md new file mode 100644 index 0000000000..93223a0d37 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_virtual_3d_energy_density_lab.md @@ -0,0 +1,60 @@ +# 3D Energy Density Lab + +Automation in 3D Energy Density Lab allows you to access to the data inside VMP maps. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the 3D Energy Density Lab, +- Some HTML example files which have VB script Automation instructions. + +Any language compatible with Automation can be used \(VB, C\#, etc.\). + +## How to call the 3D Energy Density Lab + +Before any call to the 3D Energy Density Lab methods you should use the following instruction: + +``` +Set 3DEnergyDensityLab = CreateObject("VMPViewer.Application") +``` + +This instruction automatically runs the 3D Energy Density Lab \(creates an instance of the application\). The other uses of the 3D Energy Density Lab should refer to the variable *3DEnergyDensityLab* which has been initialized with this instance. + +You could notice that there is no reference to the path where the 3D Energy Density Lab is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *VMPViewer.Application*. + +## How to call a method + +VB Script Language + +To call a method, write *3DEnergyDensityLab* followed by a **.** then by the name of the method and parameters \(strings between **"** and **"**\), each separated by **,**. For example for opening an VMP map, write the following instructions: + +``` +Dim MyVar MyVar = 3DEnergyDensityLab.OpenFile("MyMap.vmp") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar holds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the 3D Energy Density Lab. + +C\# Language + +In Framework .NET 4.5, add the TLB reference « VMPViewer.tlb » to the project. + +Add this command: using VMPViewer. + +Then, the commands can be used as follows: + +``` +VMPViewer.Application testmap = new VMPViewer.Application(); testmap.OpenFile("d:\\filename.vmp"); testmap.Show(1); +``` + +## Syntax description + +All the available methods will be described below using the following syntax: + +object.Method\_Name \(parameter 1, parameter 2, etc.\) as return\_type + +With: + +- Method\_Name: name of the method. +- Parameter n: a keyword for the type of the parameter followed by the parameter name. +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string, etc.\). \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xmax.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xmax.md new file mode 100644 index 0000000000..9505880d47 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xmax.md @@ -0,0 +1,11 @@ +# XMax + +## Description + +Gets the horizontal coordinate of the map right edge. + +## Syntax + +*object*.XMax\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xmin.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xmin.md new file mode 100644 index 0000000000..3e75bde9f3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xmin.md @@ -0,0 +1,11 @@ +# XMin + +## Description + +Gets the horizontal coordinate of the map left edge. + +## Syntax + +*object*.XMin\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xnb.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xnb.md new file mode 100644 index 0000000000..514939ff13 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xnb.md @@ -0,0 +1,11 @@ +# XNb + +## Description + +Gets the number of pixels along the horizontal axis. + +## Syntax + +*object*.XNb\(\) As Long + +*object*: Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xsamplewidth.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xsamplewidth.md new file mode 100644 index 0000000000..2582462324 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xsamplewidth.md @@ -0,0 +1,11 @@ +# XSampleWidth + +## Description + +Gets the horizontal width of each pixel of the map. + +## Syntax + +*object*.XSampleWidth\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xwidth.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xwidth.md new file mode 100644 index 0000000000..762fe307d9 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_xwidth.md @@ -0,0 +1,11 @@ +# XWidth + +## Description + +Gets the horizontal width of the map. + +## Syntax + +*object*.XWidth\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_yheight.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_yheight.md new file mode 100644 index 0000000000..09e30b93a8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_yheight.md @@ -0,0 +1,11 @@ +# YHeight + +## Description + +Gets the vertical height of the map. + +## Syntax + +*object*.YHeight\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ymax.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ymax.md new file mode 100644 index 0000000000..d6e574de7f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ymax.md @@ -0,0 +1,11 @@ +# YMax + +## Description + +Gets the vertical coordinate of the top edge of the map. + +## Syntax + +*object*.YMax\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ymin.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ymin.md new file mode 100644 index 0000000000..e752d3968b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ymin.md @@ -0,0 +1,11 @@ +# YMin + +## Description + +Gets the vertical coordinate of the bottom edge of the map. + +## Syntax + +*object*.YMin\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ynb.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ynb.md new file mode 100644 index 0000000000..488da13d3c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ynb.md @@ -0,0 +1,11 @@ +# YNb + +## Description + +Gets the number of pixels along the vertical axis. + +## Syntax + +*object*.YNb\(\) As Long + +*object*: Virtual Photometric Lab, Virtual Human Vision Lab or 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ysampleheight.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ysampleheight.md new file mode 100644 index 0000000000..eba2247e2c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_ysampleheight.md @@ -0,0 +1,11 @@ +# YSampleHeight + +## Description + +Gets the vertical height of each pixel of the map. + +## Syntax + +*object*.YSampleHeight\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zdepth.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zdepth.md new file mode 100644 index 0000000000..1a0ccd4fb2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zdepth.md @@ -0,0 +1,11 @@ +# ZDepth + +## Description + +Gets the depth of the map. + +## Syntax + +*object*.ZDepth\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zmax.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zmax.md new file mode 100644 index 0000000000..efd4835552 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zmax.md @@ -0,0 +1,11 @@ +# ZMax + +## Description + +Gets the depth coordinate of the top edge of the map. + +## Syntax + +*object*.ZMax\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zmin.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zmin.md new file mode 100644 index 0000000000..40d1338f58 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zmin.md @@ -0,0 +1,11 @@ +# ZMin + +## Description + +Gets the depth coordinate of the bottom edge of the map. + +## Syntax + +*object*.ZMin\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_znb.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_znb.md new file mode 100644 index 0000000000..c8ac362e59 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_znb.md @@ -0,0 +1,11 @@ +# ZNb + +## Description + +Gets the number of pixels along the depth axis. + +## Syntax + +*object*.ZNb\(\) As Long + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zsampledepth.md b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zsampledepth.md new file mode 100644 index 0000000000..c701d9d375 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_energy_density_lab_notused/lab3ded_zsampledepth.md @@ -0,0 +1,11 @@ +# ZSampleDepth + +## Description + +Gets the depth of each pixel of the map. + +## Syntax + +*object*.ZSampleDepth\(\) As Double + +*object*: 3D Energy Density Lab object \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_caption.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_caption.md new file mode 100644 index 0000000000..f137e5cb09 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_caption.md @@ -0,0 +1,41 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object.Caption\(\) As String* + +- *object*: XM3Viewer object + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Gets the caption + RetVal = Viewer.Caption() +End Sub +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +# Gets the caption +Caption = MyXm3Viewer.Caption() + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_export.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_export.md new file mode 100644 index 0000000000..bb2b48ecb1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_export.md @@ -0,0 +1,35 @@ +# Export + +## Description + +Exports the file in .txt format. + +Returns 1 if it succeeds, 0 otherwise. + +## Syntax + +*object.Export\(BSTR bstrFileName\) As Short* + +- *object*: XM3Viewer object + +- *bstrFileName*: filename string including path \(input\) + + +## Example + +``` +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + ' … + ' Exports the file + MyVar = Viewer.Export("C:\tmp\XM3Viewer\2cubes_005_4.txt") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_filename.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_filename.md new file mode 100644 index 0000000000..f0f3c3d185 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_filename.md @@ -0,0 +1,44 @@ +# FileName + +## Description + +Gets the file name. + +## Syntax + +*object.FileName\(\) As String* + +- *object*: XM3Viewer object + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer +Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Gets the file name + RetVal = Viewer.FileName() +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Gets the file name +filename = MyXm3Viewer.Filename() + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getactivesurfaceunit.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getactivesurfaceunit.md new file mode 100644 index 0000000000..f126c1b0fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getactivesurfaceunit.md @@ -0,0 +1,89 @@ +# GetActiveSurfaceUnit + +## Description + +Gets the active surface unit of the xm3 map: + +- **0**: Illuminance / Irradiance + +- **1**: Reflection \(Photometric / Radiometric\) + +- **2**: Transmission \(Photometric / Radiometric\) + +- **3**: Absorption \(Photometric / Radiometric\) + + +## Syntax + +*object*.GetActiveSurfaceUnit\(\) As Short + +- *object*: Virtual 3D Photometric Lab object + + +## VB script example + +```VB +Sub main() + Dim test As Integer +Dim NbC As Integer +Dim NbS As Integer +Dim MyXM3Viewer As Object +Dim retval + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim MyFile As String +MyFile = "NameOfXm3Map.xm3" + Set MyXM3Viewer = CreateObject("Xm3Viewer.Application") + retval = MyXM3Viewer.OpenFile(MyFolder & MyFile) + retval = MyXM3Viewer.Show(1) + NbC = MyXM3Viewer.GetNbConfig() +ftextfile.writeline "Nb config : " & NbC + NbS = MyXM3Viewer.GetNbSource() +ftextfile.writeline "Nb Nb Source : " & NbS + For i = 0 To NbC - 1 +test = MyXM3Viewer.SetActiveConfig(i) +Next i + For i = -2 To NbS - 1 +test = MyXM3Viewer.SetActiveSource(i) +Next i + For i = 0 To 3 +test = MyXM3Viewer.SetActiveSurfaceUnit(i) +test = MyXM3Viewer.GetActiveSurfaceUnit() +ftextfile.writeline "Unit: " & test +Next i + End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyFolder = "PathWorkSpeace" +MyFile = "NameOfXm3Map.xm3" +MyXm3Viewer.OpenFile(MyFolder + MyFile) +MyXm3Viewer.Show(1) +NbC = MyXM3Viewer.GetNbConfig() +print "Nb config: " & str(NbC) +NbS = MyXM3Viewer.GetNbSource() +print "Nb source: " & str(NbS) +i = 0 +while i < NbC: + MyXM3Viewer.SetActiveConfig(i) + i += 1 +i = 0 +while i < NbS: + MyXM3Viewer.SetActiveSource(i) + i += 1 +i = 0 +while i < 3: + MyXM3Viewer.SetActiveSurfaceUnit(i) + MyXM3Viewer.GetActiveSurfaceUnit() + i += 1 + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getnbconfig.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getnbconfig.md new file mode 100644 index 0000000000..91aa2fb5e0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getnbconfig.md @@ -0,0 +1,80 @@ +# GetNbConfig + +## Description + +Returns the number of configurations defined for the Layers Operations. + +## Syntax + +*object*.GetNbConfig\(\) As Short + +- *object*: Virtual 3D Photometric Lab object + + +## VB script example + +```VB +Sub main() + Dim test As Integer +Dim NbC As Integer +Dim NbS As Integer +Dim MyXM3Viewer As Object +Dim retval + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim MyFile As String +MyFile = "NameOfXm3Map.xm3" + Set MyXM3Viewer = CreateObject("Xm3Viewer.Application") + retval = MyXM3Viewer.OpenFile(MyFolder & MyFile) + retval = MyXM3Viewer.Show(1) + NbC = MyXM3Viewer.GetNbConfig() +ftextfile.writeline "Nb config : " & NbC + NbS = MyXM3Viewer.GetNbSource() +ftextfile.writeline "Nb Nb Source : " & NbS + For i = 0 To NbC - 1 +test = MyXM3Viewer.SetActiveConfig(i) +Next i + For i = -2 To NbS - 1 +test = MyXM3Viewer.SetActiveSource(i) +Next i + For i = 0 To 3 +test = MyXM3Viewer.SetActiveSurfaceUnit(i) +test = MyXM3Viewer.GetActiveSurfaceUnit() +ftextfile.writeline "Unit: " & test +Next i + End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyFolder = "PathWorkSpeace" +MyFile = "NameOfXm3Map.xm3" +MyXm3Viewer.OpenFile(MyFolder + MyFile) +MyXm3Viewer.Show(1) +NbC = MyXM3Viewer.GetNbConfig() +print "Nb config: " & str(NbC) +NbS = MyXM3Viewer.GetNbSource() +print "Nb source: " & str(NbS) +i = 0 +while i < NbC: + MyXM3Viewer.SetActiveConfig(i) + i += 1 +i = 0 +while i < NbS: + MyXM3Viewer.SetActiveSource(i) + i += 1 +i = 0 +while i < 3: + MyXM3Viewer.SetActiveSurfaceUnit(i) + MyXM3Viewer.GetActiveSurfaceUnit() + i += 1 + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getnbsource.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getnbsource.md new file mode 100644 index 0000000000..4cb1b84c09 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getnbsource.md @@ -0,0 +1,49 @@ +# GetNbSource + +## Description + +Returns the number of sources of the xm3 map. + +## Syntax + +*object*.GetNbSource\(\) As Short + +- *object*: Virtual 3D Photometric Lab object + + +## Example + +``` +Sub main() + Dim test As Integer +Dim NbC As Integer +Dim NbS As Integer +Dim MyXM3Viewer As Object +Dim retval + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim MyFile As String +MyFile = "NameOfXm3Map.xm3" + Set MyXM3Viewer = CreateObject("Xm3Viewer.Application") + retval = MyXM3Viewer.OpenFile(MyFolder & MyFile) + retval = MyXM3Viewer.Show(1) + NbC = MyXM3Viewer.GetNbConfig() +ftextfile.writeline "Nb config : " & NbC + NbS = MyXM3Viewer.GetNbSource() +ftextfile.writeline "Nb Nb Source : " & NbS + For i = 0 To NbC - 1 +test = MyXM3Viewer.SetActiveConfig(i) +Next i + For i = -2 To NbS - 1 +test = MyXM3Viewer.SetActiveSource(i) +Next i + For i = 0 To 3 +test = MyXM3Viewer.SetActiveSurfaceUnit(i) +test = MyXM3Viewer.GetActiveSurfaceUnit() +ftextfile.writeline "Unit: " & test +Next i + End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getpid.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getpid.md new file mode 100644 index 0000000000..e16cd96a6e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_getpid.md @@ -0,0 +1,38 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object.GetPID\(\) As Long* + +*object*: XM3Viewer object + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + Dim RetVal + ' Gets the PID + RetVal = Viewer.GetPID() +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +# Gets the PID +MyXm3Viewer.GetPID() + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_importtemplate.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_importtemplate.md new file mode 100644 index 0000000000..3a6fca6e0e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_importtemplate.md @@ -0,0 +1,37 @@ +# ImportTemplate + +## Description + +Imports a template and applies it to the current map. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +object.ImportTemplate\(BSTR bstrFileName\) as Boolean + +- *object*: Virtual 3D Photometric Lab object + +- *bstrFileName*: template filename \(.xml\) + + +## VB script example + +```VB +Sub Test_Xm3Viewer() Path = "C:\Users\jbartel\Documents\2018.1\Developpement\Labs\PBI_19720\Data\" Dim MyViewer Set MyViewer = CreateObject("Xm3Viewer.Application") Dim RetVal RetVal = MyViewer.Show(True) 'Open Test File RetVal = MyViewer.OpenFile(Path + "Old_Format_NoShape.xm3") 'Template importation Dim RetImport RetImport = MyViewer.ImportTemplate(Path + "Old_Format_NoShape.xml") MsgBox ("Fin du test.") End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +MyXm3Viewer.Show(1) +#Open test file +MyXm3Viewer.OpenFile(Path + "Old_Format_NoShape.xm3") +#Template import +MyXm3Viewer.ImportTemplate(Path + "Old_Format_NoShape.xml") + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_openfile.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_openfile.md new file mode 100644 index 0000000000..d47cca6922 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_openfile.md @@ -0,0 +1,43 @@ +# OpenFile + +## Description + +Opens the file. + +Returns 1 if it succeeds, 0 otherwise. + +## Syntax + +*object.OpenFile\(BSTR bstrFileName\) As Short* + +- *object*: XM3Viewer object + +- *bstrFileName*: filename string including path \(input\) + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_savefile.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_savefile.md new file mode 100644 index 0000000000..edf352124c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_savefile.md @@ -0,0 +1,49 @@ +# SaveFile + +## Description + +Saves the file. + +Returns 1 if it succeeds, 0 otherwise. + +## Syntax + +*object.SaveFile\(BSTR bstrFileName\) As Short* + +- *object*: XM3Viewer object + +- *bstrFileName*: filename string including path \(input\) + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + ' … + ' Saves the file + MyVar = Viewer.SaveFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#... +#Save the file +MyXm3Viewer.SaveFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactiveconfig.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactiveconfig.md new file mode 100644 index 0000000000..cab0e76c85 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactiveconfig.md @@ -0,0 +1,82 @@ +# SetActiveConfig + +## Description + +Sets the active configuration for the Layers Operations. + +## Syntax + +*object*.SetActiveConfig\(int *nConfig*\) As Short + +- *object*: Virtual 3D Photometric Lab object + +- *nConfig*: configuration index + + +## VB script example + +```VB +Sub main() + Dim test As Integer +Dim NbC As Integer +Dim NbS As Integer +Dim MyXM3Viewer As Object +Dim retval + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim MyFile As String +MyFile = "NameOfXm3Map.xm3" + Set MyXM3Viewer = CreateObject("Xm3Viewer.Application") + retval = MyXM3Viewer.OpenFile(MyFolder & MyFile) + retval = MyXM3Viewer.Show(1) + NbC = MyXM3Viewer.GetNbConfig() +ftextfile.writeline "Nb config : " & NbC + NbS = MyXM3Viewer.GetNbSource() +ftextfile.writeline "Nb Nb Source : " & NbS + For i = 0 To NbC - 1 +test = MyXM3Viewer.SetActiveConfig(i) +Next i + For i = -2 To NbS - 1 +test = MyXM3Viewer.SetActiveSource(i) +Next i + For i = 0 To 3 +test = MyXM3Viewer.SetActiveSurfaceUnit(i) +test = MyXM3Viewer.GetActiveSurfaceUnit() +ftextfile.writeline "Unit: " & test +Next i + End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyFolder = "PathWorkSpeace" +MyFile = "NameOfXm3Map.xm3" +MyXm3Viewer.OpenFile(MyFolder + MyFile) +MyXm3Viewer.Show(1) +NbC = MyXM3Viewer.GetNbConfig() +print "Nb config: " & str(NbC) +NbS = MyXM3Viewer.GetNbSource() +print "Nb source: " & str(NbS) +i = 0 +while i < NbC: + MyXM3Viewer.SetActiveConfig(i) + i += 1 +i = 0 +while i < NbS: + MyXM3Viewer.SetActiveSource(i) + i += 1 +i = 0 +while i < 3: + MyXM3Viewer.SetActiveSurfaceUnit(i) + MyXM3Viewer.GetActiveSurfaceUnit() + i += 1 + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactivesource.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactivesource.md new file mode 100644 index 0000000000..15b8fc7720 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactivesource.md @@ -0,0 +1,89 @@ +# SetActiveSource + +## Description + +Sets the active source of the xm3 map. + +## Syntax + +*object*.SetActiveSource\(int *iSource*\) As Short + +- *object*: Virtual 3D Photometric Lab object + +- *iSource*: index of the source to activate + + +You can also set the iSource behavior as follows: + +- **-1** to set all sources activated at 100% power ratio \(equivalent to the All layers mode in Virtual Photometric Lab\). + +- **-2** to activate all sources depending on their current power ratio \(equivalent to the User defined mode in Virtual Photometric Lab\). + + +## VB script example + +``` +Sub main() + Dim test As Integer +Dim NbC As Integer +Dim NbS As Integer +Dim MyXM3Viewer As Object +Dim retval + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim MyFile As String +MyFile = "NameOfXm3Map.xm3" + Set MyXM3Viewer = CreateObject("Xm3Viewer.Application") + retval = MyXM3Viewer.OpenFile(MyFolder & MyFile) + retval = MyXM3Viewer.Show(1) + NbC = MyXM3Viewer.GetNbConfig() +ftextfile.writeline "Nb config : " & NbC + NbS = MyXM3Viewer.GetNbSource() +ftextfile.writeline "Nb Nb Source : " & NbS + For i = 0 To NbC - 1 +test = MyXM3Viewer.SetActiveConfig(i) +Next i + For i = -2 To NbS - 1 +test = MyXM3Viewer.SetActiveSource(i) +Next i + For i = 0 To 3 +test = MyXM3Viewer.SetActiveSurfaceUnit(i) +test = MyXM3Viewer.GetActiveSurfaceUnit() +ftextfile.writeline "Unit: " & test +Next i + End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyFolder = "PathWorkSpeace" +MyFile = "NameOfXm3Map.xm3" +MyXm3Viewer.OpenFile(MyFolder + MyFile) +MyXm3Viewer.Show(1) +NbC = MyXM3Viewer.GetNbConfig() +print "Nb config: " & str(NbC) +NbS = MyXM3Viewer.GetNbSource() +print "Nb source: " & str(NbS) +i = 0 +while i < NbC: + MyXM3Viewer.SetActiveConfig(i) + i += 1 +i = 0 +while i < NbS: + MyXM3Viewer.SetActiveSource(i) + i += 1 +i = 0 +while i < 3: + MyXM3Viewer.SetActiveSurfaceUnit(i) + MyXM3Viewer.GetActiveSurfaceUnit() + i += 1 + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactivesurfaceunit.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactivesurfaceunit.md new file mode 100644 index 0000000000..ef21187260 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setactivesurfaceunit.md @@ -0,0 +1,88 @@ +# SetActiveSurfaceUnit + +## Description + +Sets the active surface unit of the xm3 map. Returns 0 if the surface unit is not included in the map. + +## Syntax + +*object*.SetActiveSurfaceUnit\(int *nSurfaceUnit*\) As Short + +- *object*: Virtual 3D Photometric Lab object + +- *nSurfaceUnit*: surface unit index + + - **0**: Illuminance / Irradiance + + - **1**: Reflection \(Photometric / Radiometric\) + + - **2**: Transmission \(Photometric / Radiometric\) + + - **3**: Absorption \(Photometric / Radiometric\) + + +## VB script example + +```VBVB +Sub main() + Dim test As Integer +Dim NbC As Integer +Dim NbS As Integer +Dim MyXM3Viewer As Object +Dim retval + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim MyFile As String +MyFile = "NameOfXm3Map.xm3" + Set MyXM3Viewer = CreateObject("Xm3Viewer.Application") + retval = MyXM3Viewer.OpenFile(MyFolder & MyFile) + retval = MyXM3Viewer.Show(1) + NbC = MyXM3Viewer.GetNbConfig() +ftextfile.writeline "Nb config : " & NbC + NbS = MyXM3Viewer.GetNbSource() +ftextfile.writeline "Nb Nb Source : " & NbS + For i = 0 To NbC - 1 +test = MyXM3Viewer.SetActiveConfig(i) +Next i + For i = -2 To NbS - 1 +test = MyXM3Viewer.SetActiveSource(i) +Next i + For i = 0 To 3 +test = MyXM3Viewer.SetActiveSurfaceUnit(i) +test = MyXM3Viewer.GetActiveSurfaceUnit() +ftextfile.writeline "Unit: " & test +Next i + End Sub +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyFolder = "PathWorkSpeace" +MyFile = "NameOfXm3Map.xm3" +MyXm3Viewer.OpenFile(MyFolder + MyFile) +MyXm3Viewer.Show(1) +NbC = MyXM3Viewer.GetNbConfig() +print "Nb config: " & str(NbC) +NbS = MyXM3Viewer.GetNbSource() +print "Nb source: " & str(NbS) +i = 0 +while i < NbC: + MyXM3Viewer.SetActiveConfig(i) + i += 1 +i = 0 +while i < NbS: + MyXM3Viewer.SetActiveSource(i) + i += 1 +i = 0 +while i < 3: + MyXM3Viewer.SetActiveSurfaceUnit(i) + MyXM3Viewer.GetActiveSurfaceUnit() + i += 1 +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setunittype.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setunittype.md new file mode 100644 index 0000000000..a287467797 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setunittype.md @@ -0,0 +1,52 @@ +# SetUnitType + +## Description + +Sets the unit type of the map data. + +Returns true if it succeeds, false otherwise. + +## Syntax + +*object.SetUnitType \(short nUnitType\) As Boolean* + +- *object*: XM3Viewer object + +- *nUnitType*: must have one of these values: + + - 0 for Radiometric + + - 1 for Photometric + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Sets the type of the unit with Photometric + RetVal = Viewer.SetUnitType(1) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Sets the type of the unit with Illuminance/Irradiance +Viewer.SetUnitType(0) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setvaluetype.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setvaluetype.md new file mode 100644 index 0000000000..1413f1d19a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_setvaluetype.md @@ -0,0 +1,56 @@ +# SetValueType + +## Description + +Sets the value type of the map data. + +Returns true if it succeeds, false otherwise. + +## Syntax + +*object.SetValueType \(short nValueType\) As Boolean* + +- *object*: XM3Viewer object + +- *nValueType*: must have one of these values: + + - 0 for Illuminance/Irradiance + + - 1 for Reflection + + - 2 for Transmission + + - 3 for Absorption. + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Sets the type of the value with Illuminance/Irradiance + RetVal = Viewer.SetValueType(0) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Sets the type of the value with Illuminance/Irradiance +Viewer.SetValueType(0) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_show.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_show.md new file mode 100644 index 0000000000..f090b0887c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_show.md @@ -0,0 +1,46 @@ +# Show + +## Description + +Shows or hides the GUI. + +Always returns -1. + +## Syntax + +*object.Show\(short nShow\) As Short* + +- *object*: XM3Viewer object + +- *nShow*: must have one of these values: + + - 0 for hidding + + - 1 for showing + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Shows the GUI + Viewer.Show(1) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Show the GUI +MyXm3Viewer.Show(1) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_surfaceellipsecalculation.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_surfaceellipsecalculation.md new file mode 100644 index 0000000000..886b65cd83 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_surfaceellipsecalculation.md @@ -0,0 +1,124 @@ +# SurfaceEllipseCalculation + +## Description + +Computes the measures for an ellipse area projected on the 3D surface. + +Returns an array of 13 VARIANT in the following order: + +- Minimum value + +- Minimum x coordinate + +- Minimum y coordinate + +- Minimum z coordinate + +- Maximum value + +- Maximum x coordinate + +- Maximum y coordinate + +- Maximum z coordinate + +- Flux + +- Average + +- Contrast + +- Sigma + +- RMS contrast. + + +## Syntax + +*object.SurfaceEllipseCalculation\(double dXPos, double dYPos, double dZPos, double dXDir, double dYDir, double dZDir, double dPhi, double dWidth, double dHeight, long lSampling\) As Variant* + +- *object*: XM3Viewer object + +- *dXPos*: X coordinate of the center of the measurement tool. + +- *dYPos*: Y coordinate of the center of the measurement tool. + +- *dZPos*: Z coordinate of the center of the measurement tool. + +- *dXDir*: X coordinate of the projection vector. + +- *dYDir*: Y coordinate of the projection vector. + +- *dZDir*: Z coordinate of the projection vector. + +- *dPhi*: rotation angle around the projection vector. + +- *dWidth*: width of the ellipse. + +- *dHeight*: height of the ellipse. + +- *lSampling*: number of points for the measurement. + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Computes the measures + RetVal = Viewer.SurfaceEllipseCalculation(13,13,11,0,0,-1,0,1,1,10000) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Computes the measurements +ellipseCalculation = MyXm3Viewer.SurfaceEllipseCalculation(5, 0, 0, -1, 0, 0, 0, 5, 5, 1000) +result = "" +i = 0 +print "Surface Rectangle Calculation" +for c in ellipseCalculation: + if i == 0: + print "Minimum value: " + str(c) + elif i == 1: + print "Minimum x coordinate: " + str(c) + elif i == 2: + print "Minimum y coordinate: " + str(c) + elif i == 3: + print "Minimum z coordinate: " + str(c) + elif i == 4: + print "Maximum value: " + str(c) + elif i == 5: + print "Maximum x coordinate: " + str(c) + elif i == 6: + print "Maximum y coordinate: " + str(c) + elif i == 7: + print "Maximum z coordinate: " + str(c) + elif i == 8: + print "Flux value: " + str(c) + elif i == 9: + print "Average value: " + str(c) + elif i == 10: + print "Contrast value: " + str(c) + elif i == 11: + print "Sigma value: " + str(c) + elif i == 12: + print "RMS contrast value: " + str(c) + i += 1 + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_surfacerectanglecalculation.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_surfacerectanglecalculation.md new file mode 100644 index 0000000000..19afe2dba7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_surfacerectanglecalculation.md @@ -0,0 +1,124 @@ +# SurfaceRectangleCalculation + +## Description + +Computes the measures for a rectangle area projected on the 3D surface. + +Returns an array of 13 VARIANT in the following order: + +- Minimum value + +- Minimum x coordinate + +- Minimum y coordinate + +- Minimum z coordinate + +- Maximum value + +- Maximum x coordinate + +- Maximum y coordinate + +- Maximum z coordinate + +- Flux + +- Average + +- Contrast + +- Sigma + +- RMS contrast. + + +## Syntax + +*object.SurfaceRectangleCalculation\(double dXPos, double dYPos, double dZPos, double dXDir, double dYDir, double dZDir, double dPhi, double dWidth, double dHeight, long lSampling\) As Variant* + +- *object*: XM3Viewer object + +- *dXPos*: X coordinate of the center of the measurement tool. + +- *dYPos*: Y coordinate of the center of the measurement tool. + +- *dZPos*: Z coordinate of the center of the measurement tool. + +- *dXDir*: X coordinate of the projection vector. + +- *dYDir*: Y coordinate of the projection vector. + +- *dZDir*: Z coordinate of the projection vector. + +- *dPhi*: rotation angle around the projection vector. + +- *dWidth*: width of the rectangle. + +- *dHeight*: height of the rectangle. + +- *lSampling*: number of points for the measurement. + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Computes the measures + RetVal = Viewer.SurfaceRectangleCalculation(13,13,11,0,0,-1,0,1,1,10000) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Computes the measurements +rectangleCalculation = MyXm3Viewer.SurfaceRectangleCalculation(5, 0, 0, -1, 0, 0, 0, 5, 5, 1000) +result = "" +i = 0 +print "Surface Rectangle Calculation" +for c in rectangleCalculation: + if i == 0: + print "Minimum value: " + str(c) + elif i == 1: + print "Minimum x coordinate: " + str(c) + elif i == 2: + print "Minimum y coordinate: " + str(c) + elif i == 3: + print "Minimum z coordinate: " + str(c) + elif i == 4: + print "Maximum value: " + str(c) + elif i == 5: + print "Maximum x coordinate: " + str(c) + elif i == 6: + print "Maximum y coordinate: " + str(c) + elif i == 7: + print "Maximum z coordinate: " + str(c) + elif i == 8: + print "Flux value: " + str(c) + elif i == 9: + print "Average value: " + str(c) + elif i == 10: + print "Contrast value: " + str(c) + elif i == 11: + print "Sigma value: " + str(c) + elif i == 12: + print "RMS contrast value: " + str(c) + i += 1 + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_unittype.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_unittype.md new file mode 100644 index 0000000000..4660ddeab5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_unittype.md @@ -0,0 +1,59 @@ +# UnitType + +## Description + +Gives the unit type of the map data. + +Returns: + +- -1 if Unknown + +- 0 if Radiometric + +- 1 if Photometric + + +## Syntax + +*object.UnitType As Short* + +- *object*: XM3Viewer object + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Gets the type of the unit + RetVal = Viewer.UnitType() +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Gets the type of the unit +unitType = MyXm3Viewer.UnitType() + if unitType == -1: + print "Unit type: Unknown" + elif unitType == 0: + print "Unit type: Radiometric" + elif unitType == 1: + print "Unit type: Photometric" + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_valuetype.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_valuetype.md new file mode 100644 index 0000000000..7e4af4e7fa --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_valuetype.md @@ -0,0 +1,67 @@ +# ValueType + +## Description + +Gives the value type of the map data. + +Returns: + +- -1 if Unknown + +- 0 if Illuminance/Irradiance + +- 1 if Reflection + +- 2 if Transmission + +- 3 if Absorption + + +## Syntax + +*object.ValueType As Short* + +- object: XM3Viewer object + + +## VB script example + +```VB +Sub TestLab() + ' Starts the application + Dim Viewer + Set Viewer = CreateObject("Xm3Viewer.Application") + ' Opens the file + Dim MyVar + MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3") + Dim RetVal + ' Gets the type of the value + RetVal = Viewer.ValueType() +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("Xm3Viewer.Application") +MyXm3Viewer = Activator.CreateInstance(type) +#Open the file +MyXm3Viewer.OpenFile("C:\\tmp\\XM3Viewer\\2cubes_005_4.xm3") +#Gets the type of the value +valueType = MyXm3Viewer.ValueType() + if valueType == -1: + print "Value type: Unknown" + elif valueType == 0: + print "Value type: Illuminance/Irradiance" + elif valueType == 1: + print "Value type: Reflection" + elif valueType == 2: + print "Value type: Transmission" + elif valueType == 3: + print "Value type: Absorption" + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_virtual_3d_photometric_lab.md b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_virtual_3d_photometric_lab.md new file mode 100644 index 0000000000..59a8167ed4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_3d_photometric_lab/labvp3d_virtual_3d_photometric_lab.md @@ -0,0 +1,49 @@ +# Virtual 3D Photometric Lab + +Automation in Virtual 3D Photometric Lab allows you to access to the data inside XM3 maps. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the Virtual 3D Photometric Lab, +- Some HTML example files which have VB script Automation instructions. + +All examples are given using VB Script language but any other language compatible with Automation can be used. + +## How to call the Virtual 3D Photometric Lab + +Before any call to the Virtual 3D Photometric Lab methods you should use the following instruction: + +``` +Set Viewer = CreateObject("Xm3Viewer.Application") +``` + +This instruction automatically runs the Virtual 3D Photometric Lab \(creates an instance of the application\). The other uses of the Virtual 3D Photometric Lab should refer to the variable *Viewer* which has been initialized with this instance. + +You could notice that there is no reference to the path where the Virtual 3D Photometric Lab is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *Xm3Viewer.Application*. + +## How to call a method + +To call a method, write *Viewer* followed by a **.** then by the name of the method and parameters between **"** and **"**, each separated by **,**. For example for opening an XM3 map, write the following instructions: + +``` +Dim MyVar MyVar = Viewer.OpenFile("MyMap.xm3") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar holds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the Virtual 3D Photometric Lab. + +## Syntax description + +All the available methods will be described below using the following syntax: + +``` +[number] return_type Method_Name(parameter 1, parameter 2,...); +``` + +With: + +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. +- Parameter n: A keyword for the type of the parameter followed by the parameter name. \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_basic_methods.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_basic_methods.md new file mode 100644 index 0000000000..19627187f3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_basic_methods.md @@ -0,0 +1,5 @@ +# Basic methods + +- [OpenFile](labvhv_openfile.md) +- [SaveFile](labvhv_savefile.md) +- [ExportTemplate](labvhv_exporttemplate.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_exporttemplate.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_exporttemplate.md new file mode 100644 index 0000000000..4f1ddd9ec7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_exporttemplate.md @@ -0,0 +1,37 @@ +# ExportTemplate + +## Description + +Exports the current template to a .xml format. Returns TRUE is the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExportTemplate(BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *bstrFileName*: path and filename of the template \(should end by .xml\) + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") + ' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports template +VisionLabViewer.ExportTemplate("C:\Example.xml") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports template +VisionLabViewer.ExportTemplate ("C:\\Example.xml") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_openfile.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_openfile.md new file mode 100644 index 0000000000..23aa2fb805 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_savefile.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_savefile.md new file mode 100644 index 0000000000..9109ec9e9d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/basic_methods/labvhv_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_animationlocaladaptation.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_animationlocaladaptation.md new file mode 100644 index 0000000000..192dc2e421 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_animationlocaladaptation.md @@ -0,0 +1,24 @@ +# AnimationLocalAdaptation + +## Description + +Allows exporting images of all XMP maps present in a folder to create a **.mov** file. This method allows no discontinuity between images with local adaptation, compared with ExportXMPIMage method, where local adaptation uses the maximum of each map, creating discontinuities. Options \(glare, depth of field, visual acuity\) taken into account during the export and especially the adaptation luminance. + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.AnimationLocalAdaptation\(BSTR strFolderPath, int iFormat\) As Short + +- *object*: Virtual Human Vision Lab object + +- *strFolderPath*: Path to the folder containing XMP maps. + +- *iFormat*: Image format \(0: BMP, 3: JPG, 4: PNG\) + + +## Remark + +Glare value is not reported from a XMP map to another meaning that a highly luminous source located in one map won't dazzle on the others. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_animationtimeadaptation.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_animationtimeadaptation.md new file mode 100644 index 0000000000..cbcf01c11c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_animationtimeadaptation.md @@ -0,0 +1,22 @@ +# AnimationTimeAdaptation + +## Description + +Allows exporting images of all XMP maps present in a folder, taking into account dynamic adaptation for each XMP map. Options \(glare, depth of field, visual acuity\) taken into account during the export are the ones defined for the folder's first XMP map. + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.AnimationTimeAdaptation\(BSTR strFolderPath, double dTime, int iFormat\) As Short + +- *object*: Virtual Human Vision Lab object + +- *strFolderPath*: Path to the folder containing XMP maps. + +- *dTime*: Time between each XMP map. + +- *iFormat*: Image format \(0: BMP, 3: JPG, 4: PNG\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exporting_data.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exporting_data.md new file mode 100644 index 0000000000..2ab9b6eca5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exporting_data.md @@ -0,0 +1,7 @@ +# Exporting data + +- [AnimationLocalAdaptation](labvhv_animationlocaladaptation.md) +- [AnimationTimeAdaptation](labvhv_animationtimeadaptation.md) +- [ExportXMPtoHDRI](labvhv_exportxmptohdri.md) +- [ExportXMPImage](labvhv_exportxmpimage.md) +- [ExportXMPtoResizedImage](labvhv_exportxmptoresizedimage.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmpimage.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmpimage.md new file mode 100644 index 0000000000..c1e8cfdc3f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmpimage.md @@ -0,0 +1,18 @@ +# ExportXMPImage + +## Description + +Saves the image display of the map in a file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportXMPImage\(BSTR bstrFileName, int iFormat\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: file name to save the image + +- *iFormat*: image format \(0: BMP, 1: PNG, 2 :TIFF, 3: JPG\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmptohdri.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmptohdri.md new file mode 100644 index 0000000000..910d188150 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmptohdri.md @@ -0,0 +1,18 @@ +# ExportXMPtoHDRI + +## Description + +Exports a XMP map as HDRI file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportXMPtoHDRI\(string bstrFileName, integer iFormat\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: path and filename of the HDRI. Should end by **.hdr** for RGBE files, **.exr** for OpenEXR files. + +- *iFormat*: format of the output file, 0 for OpenEXR, 1 for RGBE. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmptoresizedimage.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmptoresizedimage.md new file mode 100644 index 0000000000..a814286e0d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/exporting_data/labvhv_exportxmptoresizedimage.md @@ -0,0 +1,40 @@ +# ExportXMPtoResizedImage + +## Description + +Exports the current view of an XMP map as an image \(based on the current display settings and size specifications\). + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExportXMPtoResizedImage(BSTR bstrFileName, double ratio)` as Boolean +- *object*: Virtual Human Vision Lab +- *bstrFileName*: path and filename of the BMP, PNG, TIFF or JPG. Should end by **.BMP**, **.PNG**, **.TIFF** or **.JPG**. +- *ratio*: ratio \(multiplication factor\) applied to the exported image. Should be greater than 0 and comprised between 0.001 and 100. + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports the XMP map +VisionLabViewer.ExportXMPtoResizedImage("C:\Example.png", 10) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports XMP map +retval = VisionLabViewer.ExportXMPtoResizedImage("C:\\Example.png", 10) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extended_and_spectral_map.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extended_and_spectral_map.md new file mode 100644 index 0000000000..aa8923e05d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extended_and_spectral_map.md @@ -0,0 +1,16 @@ +# Extended and spectral map + +- [ExtendedSetSourceName](labvhv_extendedsetsourcename.md) +- [ExtendedGetSourceName](labvhv_extendedgetsourcename.md) +- [ExtendedSetConfigName](labvhv_extendedsetconfigname.md) +- [ExtendedGetConfigName](labvhv_extendedgetconfigname.md) +- [ExtendedCreateConfig](labvhv_extendedcreateconfig.md) +- [ExtendedGetNbConfig](labvhv_extendedgetnbconfig.md) +- [ExtendedGetNbSource](labvhv_extendedgetnbsource.md) +- [ExtendedSetActiveConfig](labvhv_extendedsetactiveconfig.md) +- [ExtendedSetActiveSource](labvhv_extendedsetactivesource.md) +- [ExtendedSetSourceRatio](labvhv_extendedsetsourceratio.md) +- [ExtendedGetSourceRatio](labvhv_extendedgetsourceratio.md) +- [ExtendedActivateSourceLayer](labvhv_extendedactivatesourcelayer.md) +- [SpectralGetActiveWavelength](labvhv_spectralgetactivewavelength.md) +- [SpectralSpectrumChange](labvhv_spectralspectrumchange.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedactivatesourcelayer.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedactivatesourcelayer.md new file mode 100644 index 0000000000..bc178300f9 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedactivatesourcelayer.md @@ -0,0 +1,27 @@ +# ExtendedActivateSourceLayer + +## Description + +Activates one source of an extended map. + +In case of error, returns -1 if: + +- no source in the map + +- iSource \>= number of sources in the map + +- iSource \< 0 + + +## Syntax + +*object*.ExtendedActivateSourceLayer\(int iSource, bool bActive\) As Short + +- *object*: Virtual Photometric Lab or Human Vision Lab object + +- *iSource*: index of the source to consider + +- *bActive*: true to activate the source, false to deactivate it + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedcreateconfig.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedcreateconfig.md new file mode 100644 index 0000000000..cd13fd0d45 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedcreateconfig.md @@ -0,0 +1,39 @@ +# ExtendedCreateConfig + +## Description + +Creates a new configuration. The name of the new configuration has to be specified in the creation method. The name of the new configuration must be unique and not empty. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedCreateConfig(BSTR bstrConfigName)` as Boolean +- *object*: Virtual Human Vision Lab +- *bstrConfigName*: name of the configuration + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Creates a new configuration +VisionLabViewer.ExtendedCreateConfig("My Configuration") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Creates a new configuration +VisionLabViewer.ExtendedCreateConfig("My Configuration") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetconfigname.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetconfigname.md new file mode 100644 index 0000000000..c0d38a2b2e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetconfigname.md @@ -0,0 +1,48 @@ +# ExtendedGetConfigName + +## Description + +Gets the name of the configuration number N. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedGetConfigName(int iConfig, VARIANT* ovConfigName)` as Boolean +- *object*: Virtual Human Vision Lab +- *iConfig*: index of the configuration in Virtual Lighting Controller \(starting from 0\) +- *ovConfigName*: name of the configuration + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Gets the name of the configuration #3 +Dim sConfigName +VisionLabViewer.ExtendedGetConfigName(3, sConfigName) +' Prints the name of the configuration #3 +Dim ConfigName As String +ConfigName = sConfigName(1) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Gets the name of the configuration number 3 +sConfigName = clr.Reference[System.Object]() #Create a default pointer +retval = VisionLabViewer.ExtendedGetConfigName(2, sConfigName) +# Prints the name of the configuration number 3 +configName = sConfigName.Value +print configName[0] +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetnbconfig.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetnbconfig.md new file mode 100644 index 0000000000..c9dc492769 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetnbconfig.md @@ -0,0 +1,14 @@ +# ExtendedGetNbConfig + +## Description + +Returns the number of configurations defined for the Layers Operations. + +## Syntax + +*object*.ExtendedGetNbConfig\(\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetnbsource.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetnbsource.md new file mode 100644 index 0000000000..9fccdac292 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetnbsource.md @@ -0,0 +1,14 @@ +# ExtendedGetNbSource + +## Description + +Returns the number of sources of an extended or a spectral map \(0 if the map is not an extended or a spectral map\). + +## Syntax + +*object*.ExtendedGetNbSource\(\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetsourcename.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetsourcename.md new file mode 100644 index 0000000000..639bf90d42 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetsourcename.md @@ -0,0 +1,48 @@ +# ExtendedGetSourceName + +## Description + +Gets the name of the source number N. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedGetSourceName(int iSource, VARIANT* ovSourceName)` as Boolean +- *object*: Virtual Human Vision Lab +- *iSource*: index of the source in Virtual Lighting Controller \(starting from 0\) +- *ovSourceName*: name of the source + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Gets the name of the source #3 +Dim sSourceName +VisionLabViewer.ExtendedGetSourceName(3, sSourceName) +' Prints the name of the source #3 +Dim SourceName As String +SourceName = sSourceName(1) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Gets the name of the source number 3 +sSourceName = clr.Reference[System.Object]() #Creates a default pointer +retval = VisionLabViewer.ExtendedGetSourceName(2, sSourceName) +# Prints the name of the source number 3 +sourceName = sSourceName.Value +print sourceName[0] +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetsourceratio.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetsourceratio.md new file mode 100644 index 0000000000..9fb27cf119 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedgetsourceratio.md @@ -0,0 +1,27 @@ +# ExtendedGetSourceRatio + +## Description + +Gets the value of one of the sources of an extended or a spectral map. + +In case of error, returns -1 if: + +- the map is neither an extended nor a spectral map + +- no source in the map + +- iSource \>= number of sources in the map + +- iSource \< 0 + + +## Syntax + +*object*.ExtendedGetSourceRatio\(int iSource\) As Double + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetactiveconfig.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetactiveconfig.md new file mode 100644 index 0000000000..47929307e8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetactiveconfig.md @@ -0,0 +1,16 @@ +# ExtendedSetActiveConfig + +## Description + +Sets the active configuration for the Layers Operations. + +## Syntax + +*object*.ExtendedSetActiveConfig\(int nConfig\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *nConfig*: configuration index + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetactivesource.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetactivesource.md new file mode 100644 index 0000000000..828a8de55c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetactivesource.md @@ -0,0 +1,15 @@ +# ExtendedSetActiveSource + +## Description + +Sets the active source of an extended or a spectral map \(0 if the map is not an extended or a spectral map\). + +## Syntax + +*object*.ExtendedSetActiveSource\(int iSource\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source to activate + + You can set the *iSource*behavior as follows: - **-1** to set all sources activated at 100% power ratio \(equivalent to the *All layers*mode in Virtual Photometric Lab\). - **-2** to activate all sources depending on their current power ratio \(equivalent to the *User defined* mode in Virtual Photometric Lab\). diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetconfigname.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetconfigname.md new file mode 100644 index 0000000000..065ae717a6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetconfigname.md @@ -0,0 +1,40 @@ +# ExtendedSetConfigName + +## Description + +Sets the name of the configuration number N. The new name of the configuration must be unique and not empty. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedSetConfigName(int iConfig, BSTR bstrConfigName)` as Boolean +- *object*: Virtual Human Vision Lab +- *iConfig*: index of the configuration in Virtual Lighting Controller \(starting from 0\) +- *bstrConfigName*: name of the configuration + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Sets the name of the configuration #3 +VisionLabViewer.ExtendedSetConfigName(3, "My Configuration") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Sets the name of the configuration number 3 +retval = VisionLabViewer.ExtendedSetConfigName(2, “My Configuration”) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetsourcename.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetsourcename.md new file mode 100644 index 0000000000..329b96418b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetsourcename.md @@ -0,0 +1,38 @@ +# ExtendedSetSourceName + +## Description + +Renames one of the sources. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedSetSourceName(int iSource, BSTR bstrSourceName)` as Boolean +- *object*: Virtual Human Vision Lab +- *iSource*: index of the source in Virtual Lighting Controller \(starting from 0\) +- *bstrFileName*: the new name of the source + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Renames source #1 +VisionLabViewer.ExtendedSetSourceName(1, "Source number one") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Renames the second source +VisionLabViewer. ExtendedSetSourceName(1, " Source number two") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetsourceratio.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetsourceratio.md new file mode 100644 index 0000000000..fd714887f9 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_extendedsetsourceratio.md @@ -0,0 +1,23 @@ +# ExtendedSetSourceRatio + +## Description + +Sets the value of one of the sources of an extended or a spectral map \(0 if the map is not an extended or a spectral map\). + +**Note:** + +The *User defined* mode must be active \(*ExtendedSetActiveSource\(-2\)*\) for the power ratio to be effective +before using the *ExtendedSetSourceRatio* method. See the [ExtendedSetActiveSource](labvhv_extendedsetactivesource.md) chapter for more details. + +## Syntax + +*object*.ExtendedSetSourceRatio\(int iSource, double dRatio\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source + +- *dRatio*: value to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_spectralgetactivewavelength.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_spectralgetactivewavelength.md new file mode 100644 index 0000000000..9df0cba360 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_spectralgetactivewavelength.md @@ -0,0 +1,16 @@ +# SpectralGetActiveWavelength + +## Description + +Gets the active wavelengths of a spectral map. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SpectralGetActiveWavelength\(VARIANT\* ovWavelengthIndex\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovWavelengthIndex*: VARIANT of the index of the active wavelength \(-1 for all\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_spectralspectrumchange.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_spectralspectrumchange.md new file mode 100644 index 0000000000..472d762681 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/extended_and_spectral_map/labvhv_spectralspectrumchange.md @@ -0,0 +1,55 @@ +# SpectralSpectrumChange + +## Description + +Allows you to apply a spectrum to a source on spectral map. + +Returns 0 if: + +- the map is not a spectral map. + +- the index of the source does not exist. + +- the path does not exist or no path defined or wrong path. + + +## Syntax + +*object*.SpectralSpectrumChange\(int *iSource*, BSTR *bstrFileName*\) + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source to activate + +- *bstrFileName*: filename string including path + + When bstrFileName does not exist, the spectrum is deactivated on the layer. + + +## Example + +``` +Sub main() + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim XmpViewer As Object +Set XmpViewer = CreateObject("XmpViewer.Application") + Dim MyFile As String +MyFile = "NameOfXmpMap.xmp" + retval = XmpViewer.OpenFile(MyFolder & MyFile) + retval = XmpViewer.Show(1) + Dim NbLayer As Integer +NbLayer = XmpViewer.ExtendedGetNbSource() + Dim MySpectrumFile As String +MySpectrumFile = "NameOfSpectrumFile.spectrum" + For i = 0 To NbLayer - 1 +retval = XmpViewer.SpectralSpectrumChange(i, MyFolder & MySpectrumFile) +Next i + For i = 0 To NbLayer - 1 +retval = XmpViewer.SpectralSpectrumChange(i) +Next i + End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filtering.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filtering.md new file mode 100644 index 0000000000..b2832958fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filtering.md @@ -0,0 +1,16 @@ +# Filtering + +## Description + +Applies the XMP filtering on the map data. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.Filtering\(int iNbPasses\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iNbPasses*: filtering level + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filtering_data.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filtering_data.md new file mode 100644 index 0000000000..af965a35be --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filtering_data.md @@ -0,0 +1,4 @@ +# Filtering data + +- [Filtering](labvhv_filtering.md) +- [FilteringRemoveHighestPeaks](labvhv_filteringremovehighestpeaks.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filteringremovehighestpeaks.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filteringremovehighestpeaks.md new file mode 100644 index 0000000000..60cb63a26c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/filtering_data/labvhv_filteringremovehighestpeaks.md @@ -0,0 +1,18 @@ +# FilteringRemoveHighestPeaks + +## Description + +Applies the XMP filtering and removes highest peaks on the map data. Returns a value different than 0 if no error has occurred. + +## Syntax + +*object*.FilteringRemoveHighestPeaks\(int nNbPasses, double dThreshold\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iNbPasses*: filtering level + +- *dThreshold*: threshold value for removing highest peaks + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/labvhv_virtual_human_vision_lab.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/labvhv_virtual_human_vision_lab.md new file mode 100644 index 0000000000..297a9b6a8a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/labvhv_virtual_human_vision_lab.md @@ -0,0 +1,45 @@ +# Virtual Human Vision Lab + +Automation in Virtual Human Vision Lab allows you to access to the data inside XMP maps. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the Human Vision Lab Viewer, +- Some HTML example files which have VB script Automation instructions. + +All examples are given using VB Script language but any other language compatible with Automation can be used. + +## How to call the Virtual Human Vision Lab + +Before any call to the Virtual Human Vision Lab methods you should use the following instruction: + +``` +Set VirtualHumanVisionLab = CreateObject("VisionLabViewer.Application") + +``` + +This instruction automatically runs the Virtual Human Vision Lab \(creates an instance of the application\). The other uses of the Virtual Human Vision Lab should refer to the variable *VirtualHumanVisionLab*which has been initialized with this instance. + +You might notice that there is no reference to the path where the Virtual Human Vision Lab is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *VisionLabViewer.Application*. + +## How to call a method + +To call a method, write *VirtualHumanVisionLab* followed by a **.** then by the name of the method and parameters between **"** and **"**, each separated by **,**. For example for opening an XMP map, write the following instructions: + +``` +Dim MyVar MyVar = VirtualHumanVisionLab.OpenFile("MyMap.xmp") + +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar olds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the Virtual Human Vision Lab. + +All the available methods will be described below using the following syntax: +``` +[number] return\_type Method\_Name\(parameter 1, parameter 2,...\); +``` +with: +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. Parameter n: A keyword for the type of the parameter followed by the parameter name. diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_accomodationdistance.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_accomodationdistance.md new file mode 100644 index 0000000000..2e8c5d1050 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_accomodationdistance.md @@ -0,0 +1,16 @@ +# AccomodationDistance + +## Description + +Sets the accomodation distance. Returns 0 if no error has occurred, 1 otherwise. + +## Syntax + +*object*.AccomodationDistance\(double dAccomodationDistance\) As Short + +- *object*: Virtual Human Vision Lab object + +- *dAccomodationDistance*: accomodation distance value. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_activateglare.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_activateglare.md new file mode 100644 index 0000000000..219f2d75aa --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_activateglare.md @@ -0,0 +1,19 @@ +# ActivateGlare + +## Description + +Applies glare on the map and returns 0 if no error has occurred. + +## Syntax + +*object*.ActivateGlare\(short bGlareOn\) As Short + +- *object*: Virtual Human Vision Lab object + +- *bGlareOn*: any value different from 0 to activate, 0 to inactivate. + + +In order for the display to take these changes into account, you need to call the +[UpdateDisplayAndData](labvhv_updatedisplayanddata.md) method. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_adaptationtype.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_adaptationtype.md new file mode 100644 index 0000000000..d7663ca528 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_adaptationtype.md @@ -0,0 +1,16 @@ +# AdaptationType + +## Description + +Sets the adaptation type and returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.AdaptationType\(short nAdaptationType\) As Short + +- *object*: Virtual Human Vision Lab object + +- *nAdaptationType*: 0 for Dynamic, 1 for Local + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_aperture.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_aperture.md new file mode 100644 index 0000000000..42a6e855a2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_aperture.md @@ -0,0 +1,16 @@ +# Aperture + +## Description + +Sets the aperture. Returns 0 if no error has occurred, 1 otherwise. + +## Syntax + +*object*.Aperture\(double dAperture\) As Short + +- *object*: Virtual Human Vision Lab object + +- *dAperture*: new aperture value. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_caption.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_caption.md new file mode 100644 index 0000000000..e61adc0401 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_caption.md @@ -0,0 +1,14 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object*.Caption\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_dof.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_dof.md new file mode 100644 index 0000000000..fbfccae7b4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_dof.md @@ -0,0 +1,16 @@ +# DOF + +## Description + +Modifies the depth of field state. Returns 0 if no error has occurred, 1 otherwise. + +## Syntax + +*object*.DOF\(short nDOF\) As Short + +- *object*: Virtual Human Vision Lab object + +- *nDOF*: Depth of field state. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_focal.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_focal.md new file mode 100644 index 0000000000..52a6dcdc66 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_focal.md @@ -0,0 +1,16 @@ +# Focal + +## Description + +Sets the focal distance. Returns 0 if no error has occurred, 1 otherwise. + +## Syntax + +*object*.Focal\(double dFocal\) As Short + +- *object*: Virtual Human Vision Lab object + +- *dFocal*: new focal distance value + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_gamutmapping.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_gamutmapping.md new file mode 100644 index 0000000000..aeab05257c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_gamutmapping.md @@ -0,0 +1,16 @@ +# GamutMapping + +## Description + +Sets the gamut mapping and returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.GamutMapping\(short nGamutMapping\) As Short + +- *object*: Virtual Human Vision Lab object + +- *nGamutMapping*: 0 for **Gamut Clipping**, 2 for **Maintain Lightness and Hue**, 3 for **Maintain Hue**, 4 for **Colorimetric error**. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getcolor.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getcolor.md new file mode 100644 index 0000000000..f204ee2a1e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getcolor.md @@ -0,0 +1,36 @@ +# GetColor + +## Description + +Returns an array of 3 VARIANT of the colorimetric coordinates at the given position. + +## Syntax + +*object*.GetColor\(double dXPos, double dYPos, short nColorSystem\) As Variant + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *dX*: horizontal coordinate + +- *dY*: vertical coordinate + +- *nColorSystem*: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh + + For 4, 5 and 6, the illuminant defined in the Virtual Photometric Lab is taken into account. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getdepth.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getdepth.md new file mode 100644 index 0000000000..78df7e4aee --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getdepth.md @@ -0,0 +1,18 @@ +# GetDepth + +## Description + +Returns the depth of a point located at given coordinates. + +## Syntax + +*object*.GetDepth\(short iX, short iY\) As Double + +- *object*: Virtual Human Vision Lab object + +- *iX*: horizontal coordinate + +- *iY*: vertical coordinate + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getpid.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getpixellistonsurface.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getpixellistonsurface.md new file mode 100644 index 0000000000..316b72bd0b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getpixellistonsurface.md @@ -0,0 +1,18 @@ +# GetPixelListOnSurface + +## Description + +Returns an array of Variant of the pixel indexes that are in the current area. + +## Syntax + +*object*.GetPixelListOnSurface\(VARIANT\* vPtX, VARIANT\* vPtY\) As Short + +- *Object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *vPtX*: array of VARIANT for the horizontal indexes of each pixel in the area + +- *vPtY*: array of VARIANT for the vertical indexes of each pixel in the area + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getselectedlayer.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getselectedlayer.md new file mode 100644 index 0000000000..2e511ffa08 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getselectedlayer.md @@ -0,0 +1,16 @@ +# GetSelectedLayer + +## Description + +Gets a layer of a multi layer map. Returns 1 if no error has occurred \(map with layers\), 0 otherwise. + +## Syntax + +*object*.GetSelectedLayer\(VARIANT\* ovLayerIndex\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovLayerIndex*: VARIANT of the index of the active layer \(-1 for all, -2 if many\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getselectedlayersuser.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getselectedlayersuser.md new file mode 100644 index 0000000000..cb91405143 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_getselectedlayersuser.md @@ -0,0 +1,16 @@ +# GetSelectedLayersUser + +## Description + +Gets selected layers of a multi layer map. Returns a value different than 0 if no error occurred. + +## Syntax + +*object*.GetSelectedLayersUser\(VARIANT\* ovLayerIndexes\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovLayerIndex*: an array of VARIANT of the indexes of all active layers + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_luminanceadaptation.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_luminanceadaptation.md new file mode 100644 index 0000000000..68c1395173 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_luminanceadaptation.md @@ -0,0 +1,16 @@ +# LuminanceAdaptation + +## Description + +Sets the adaptation luminance value and returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.LuminanceAdaptation\(double dLuminanceAdaptation\) As Short + +- *object*: Virtual Human Vision Lab object + +- *dLuminanceAdaptation*: adaptation luminance value + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_map_and_display_option.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_map_and_display_option.md new file mode 100644 index 0000000000..c0c9ab998d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_map_and_display_option.md @@ -0,0 +1,35 @@ +# Map and display option + +- [AccomodationDistance](labvhv_accomodationdistance.md) +- [ActivateGlare](labvhv_activateglare.md) +- [AdaptationType](labvhv_adaptationtype.md) +- [Aperture](labvhv_aperture.md) +- [Caption](labvhv_caption.md) +- [DOF](labvhv_dof.md) +- [Focal](labvhv_focal.md) +- [GamutMapping](labvhv_gamutmapping.md) +- [GetColor](labvhv_getcolor.md) +- [GetDepth](labvhv_getdepth.md) +- [GetPID](labvhv_getpid.md) +- [GetPixelListOnSurface](labvhv_getpixellistonsurface.md) +- [GetSelectedLayer](labvhv_getselectedlayer.md) +- [GetSelectedLayersUser](labvhv_getselectedlayersuser.md) +- [LuminanceAdaptation](labvhv_luminanceadaptation.md) +- [NightVisionGoggles](labvhv_nightvisiongoggles.md) +- [SetAutomaticGrid](labvhv_setautomaticgrid.md) +- [SetDisplayMode](labvhv_setdisplaymode.md) +- [SetGlareAlgorithm](labvhv_setglarealgorithm.md) +- [SetGridOrigin](labvhv_setgridorigin.md) +- [SetLocalAdaptationLuminanceMax](labvhv_setlocaladaptationluminancemax.md) +- [SetPrimaryGridSteps](labvhv_setprimarygridsteps.md) +- [SetSecondaryGraduationNbs](labvhv_setsecondarygraduationnb.md) +- [Show](labvhv_show.md) +- [SpectralFiltering](labvhv_spectralfiltering.md) +- [SpectralGetActiveWavelength](labvhv_spectralgetactivewavelength.md) +- [UpdateDisplayAndData](labvhv_updatedisplayanddata.md) +- [UpdateDisplayAndDataForVR](labvhv_updatedisplayanddataforvr.md) +- [VisionModeEvaluationType](labvhv_visionmodeevaluationtype.md) +- [ShowRuler](labvhv_showruler.md) +- [ShowPrimaryGrid](labvhv_showprimarygrid.md) +- [ShowSecondaryGrid](labvhv_showsecondarygrid.md) +- [SetAlwaysOnTop](labvhv_setalwaysontop.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_nightvisiongoggles.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_nightvisiongoggles.md new file mode 100644 index 0000000000..7686683f0e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_nightvisiongoggles.md @@ -0,0 +1,16 @@ +# NightVisionGoggles + +## Description + +Activates or deactivates night vision goggle data contained in **.nvg** files. Night vision goggle data can be generated using the editor inside Virtual Photometric Lab/Virtual Human Vision Lab. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.NightVisionGoggles\(BSTR strNVGFileName\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *strNVGFileName*: Name of the **.nvg** file containing night vision goggle data. To deactivate the filter, enter a void string. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setalwaysontop.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setalwaysontop.md new file mode 100644 index 0000000000..95c044c2cd --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setalwaysontop.md @@ -0,0 +1,32 @@ +# SetAlwaysOnTop + +## Description + +Sets the window always on the top of the screen. **True** by default. + +Returns a value different than 0 if no error occurred. + +## Syntax + +*object*.SetAlwaysOnTop\(short *bAlwaysOnTop*\) As Short + +- *object*: Virtual Human Vision Lab object + +- *bAlwaysOnTop*: boolean being **True** to set the window always on the top or **False** else + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualHumanVisionLab = CreateObject("VisionLabViewer.Application") +Error = VirtualHumanVisionLab.Show(True) +Error = VirtualHumanVisionLab.OpenFile("C:\TailLampVE.xmp") +'Show the secondary grid +Error = VirtualHumanVisionLab.SetAlwaysOnTop(True) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setautomaticgrid.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setautomaticgrid.md new file mode 100644 index 0000000000..60f4c35840 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setautomaticgrid.md @@ -0,0 +1,51 @@ +# SetAutomaticGrid + +## Description + +Set the mode of definition for the grid. The grid can be defined automatically \(**True**\) or user-defined \(**False**\) + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetAutomaticGrid\(bAutomaticGrid As Integer\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bAutomaticGrid*: boolean being **True** \(automatic mode\) or **False** \(user-defined mode\) + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetPrimaryGridSteps(5, 10) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) 'Activate the user-defined grid +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +XMPViewer.ShowPrimaryGrid(True) +XMPViewer.ShowRuler(True) +XMPViewer.SetPrimaryGridSteps(5, 10) +XMPViewer.SetAutomaticGrid(False) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setdisplaymode.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setdisplaymode.md new file mode 100644 index 0000000000..a9e80caf92 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setdisplaymode.md @@ -0,0 +1,16 @@ +# SetDisplayMode + +## Description + +Sets the display mode. + +## Syntax + +*object*.SetDisplayMode\(short nMode\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *nMode*: display mode \(0 for standard, 1 for full screen, 2 for full screen and stretched image\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setglarealgorithm.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setglarealgorithm.md new file mode 100644 index 0000000000..d235a2420a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setglarealgorithm.md @@ -0,0 +1,23 @@ +# SetGlareAlgorithm + +## Description + +Allows you to select the glare algorithm. + +## Syntax + +*object*.SetGlareAlgorithm\(short nType\) As Short + +- *object*: Virtual Human Vision Lab object + +- *nType*: glare algorithm + + 0 : Vos + + 1: Holladay + + +In order for the display to take these changes into account, you need to call the +[UpdateDisplayAndData](labvhv_updatedisplayanddata.md) method. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setgridorigin.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setgridorigin.md new file mode 100644 index 0000000000..7d25a0e201 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setgridorigin.md @@ -0,0 +1,36 @@ +# SetGridOrigin + +## Description + +Set the position of the grid origin. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetGridOrigin\(*dOriginX*As Double, *dOriginY*As Double\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *dOriginX:*horizontal position of the grid origin + +- *dOriginY:*vertical position of the grid origin + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetGridOrigin(2, 3) 'Origin is user-defined (XOrigin=2mm; YOrigin=3mm) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setlocaladaptationluminancemax.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setlocaladaptationluminancemax.md new file mode 100644 index 0000000000..a597c03c59 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setlocaladaptationluminancemax.md @@ -0,0 +1,16 @@ +# SetLocalAdaptationLuminanceMax + +## Description + +Sets the maximum luminance value used for local adaptation. If this method is not used, the maximum luminance value used is the maximum luminance value on the XMP. + +## Syntax + +*object*.SetLocalAdaptationLuminanceMax\(double dLuminanceMax\) As Short + +- *object*: Virtual Human Vision Lab object + +- *dLuminanceMax*: maximum luminance value + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setprimarygridsteps.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setprimarygridsteps.md new file mode 100644 index 0000000000..e97bb5980d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setprimarygridsteps.md @@ -0,0 +1,53 @@ +# SetPrimaryGridSteps + +## Description + +Set the steps of the primary grid. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetPrimaryGridSteps\(*dStepX*As Double, *dStepY*As Double\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *dStepX:*horizontal step of the primary grid + +- *dStepY:*vertical step of the primary grid + + +## VB script example + +``` +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetPrimaryGridSteps(5, 10) 'Grid steps of the primary grid are user-defined (XPrimaryStep=5mm; YPrimaryStep=10mm) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +XMPViewer.ShowPrimaryGrid(True) +XMPViewer.ShowRuler(True) +XMPViewer.SetPrimaryGridSteps(5, 10) +XMPViewer.SetAutomaticGrid(False) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setsecondarygraduationnb.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setsecondarygraduationnb.md new file mode 100644 index 0000000000..ff20ef44d0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_setsecondarygraduationnb.md @@ -0,0 +1,37 @@ +# SetSecondaryGraduationNbs + +## Description + +Set the number of graduations of the secondary grid. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetSecondaryGraduationNbs\(*iGradNbX*As Long, *iGradNbY*As Long\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iGradNbX:*horizontal number of graduations for the secondary grid + +- *iGradNbY:*vertical number of graduations for the secondary grid + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) +Error = VirtualPhotometricLab.SetSecondaryGraduationNbs(10, 10) 'Graduation number of the secondary grid is user-defined (XSecondaryGraduationNb=5mm; YSecondaryGraduationNb=10mm) +Error = VirtualPhotometricLab.ShowSecondaryGrid(True) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_show.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_show.md new file mode 100644 index 0000000000..ca86402f34 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: BSDF -BRDF Anisotropic Viewer, Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showprimarygrid.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showprimarygrid.md new file mode 100644 index 0000000000..fc637c322e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showprimarygrid.md @@ -0,0 +1,32 @@ +# ShowPrimaryGrid + +## Description + +Shows the primary grid inside the viewer. + +Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.ShowPrimaryGrid\(short *bShowPrimaryGrid*\) As Short + +- *object*: Virtual Human Vision Lab object + +- *bShowPrimaryGrid*: boolean being **True** to show or False else + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualHumanVisionLab = CreateObject("VisionLabViewer.Application") +Error = VirtualHumanVisionLab.Show(True) +Error = VirtualHumanVisionLab.OpenFile("C:\TailLampVE.xmp") +'Show the primary grid +Error = VirtualHumanVisionLab.ShowPrimaryGrid(True) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showruler.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showruler.md new file mode 100644 index 0000000000..650adc2c12 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showruler.md @@ -0,0 +1,32 @@ +# ShowRuler + +## Description + +Shows the rulers inside the viewer. + +Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.ShowRuler\(short *bShowRuler*\) As Short + +- *object*: Virtual Human Vision Lab object + +- *bShowRuler*: boolean being **True** to show or False else + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualHumanVisionLab = CreateObject("VisionLabViewer.Application") +Error = VirtualHumanVisionLab.Show(True) +Error = VirtualHumanVisionLab.OpenFile("C:\TailLampVE.xmp") +'Show the rulers +Error = VirtualHumanVisionLab.ShowRuler(True) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showsecondarygrid.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showsecondarygrid.md new file mode 100644 index 0000000000..7e9d49ed04 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_showsecondarygrid.md @@ -0,0 +1,32 @@ +# ShowSecondaryGrid + +## Description + +Shows the secondary grid inside the viewer. + +Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.ShowSecondaryGrid\(short bShowSecondaryGrid\) As Short + +- *object*: Virtual Human Vision Lab object + +- *bShowSecondaryGrid*: boolean being **True** to show or False else + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualHumanVisionLab = CreateObject("VisionLabViewer.Application") +Error = VirtualHumanVisionLab.Show(True) +Error = VirtualHumanVisionLab.OpenFile("C:\TailLampVE.xmp") +'Show the secondary grid +Error = VirtualHumanVisionLab.ShowSecondaryGrid(True) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_spectralfiltering.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_spectralfiltering.md new file mode 100644 index 0000000000..2e97015c4a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_spectralfiltering.md @@ -0,0 +1,16 @@ +# SpectralFiltering + +## Description + +Activates or deactivates color filter spectrum or sun glasses spectrum. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SpectralFiltering\(BSTR strSpectralFilterFileName\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *strSpectralFilterFileName*: path to the spectrum name. To deactivate the filter, enter a void string. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_spectralgetactivewavelength.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_spectralgetactivewavelength.md new file mode 100644 index 0000000000..9df0cba360 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_spectralgetactivewavelength.md @@ -0,0 +1,16 @@ +# SpectralGetActiveWavelength + +## Description + +Gets the active wavelengths of a spectral map. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SpectralGetActiveWavelength\(VARIANT\* ovWavelengthIndex\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovWavelengthIndex*: VARIANT of the index of the active wavelength \(-1 for all\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_updatedisplayanddata.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_updatedisplayanddata.md new file mode 100644 index 0000000000..78fa9b0fc2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_updatedisplayanddata.md @@ -0,0 +1,16 @@ +# UpdateDisplayAndData + +## Description + +Update all the display and the data of the Viewer. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.UpdateDisplayAndData\(\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + +Some methods modify the display options \(for example ExtendedSetActiveConfig\). In order for the display to take these changes into account, calling the UpdateDisplayAndData method may be necessary. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_updatedisplayanddataforvr.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_updatedisplayanddataforvr.md new file mode 100644 index 0000000000..9787787cb3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_updatedisplayanddataforvr.md @@ -0,0 +1,14 @@ +# UpdateDisplayAndDataForVR + +## Description + +Update all the display and the data according to new options. The maximum luminance value is not replaced by the maximum luminance value on the map. + +## Syntax + +*object*.UpdateDisplayAndDataForVR\(\) As Double + +- *object*: Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_visionmodeevaluationtype.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_visionmodeevaluationtype.md new file mode 100644 index 0000000000..1242d2a252 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_and_display_option/labvhv_visionmodeevaluationtype.md @@ -0,0 +1,22 @@ +# VisionModeEvaluationType + +## Description + +Allows you to select the way to evaluate the vision mode \(photopic, mesopic, scotopic\). + +## Syntax + +*object*.VisionModeEvaluationType\(short nType\) As Short + +- *object*: Virtual Human Vision Lab object + +- *nType*: vision mode type + + 0: mean value of luminance map + + 1: max value of luminance map + + 2: vision mode computed for each pixel + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_filename.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_filename.md new file mode 100644 index 0000000000..ce79c18934 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_filename.md @@ -0,0 +1,14 @@ +# Filename + +## Description + +Gets the file name of a file. + +## Syntax + +*object*.FileName\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_map_information.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_map_information.md new file mode 100644 index 0000000000..0a78e9058a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_map_information.md @@ -0,0 +1,6 @@ +# Map information + +- [Filename](labvhv_filename.md) +- [Position](labvhv_position.md) +- [XNb](labvhv_xnb.md) +- [YNb](labvhv_ynb.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_position.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_position.md new file mode 100644 index 0000000000..dc1fc051fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_position.md @@ -0,0 +1,16 @@ +# Position + +## Description + +Sets the position in a Virtual Photometric Lab/Virtual Human Vision Lab window. Returns 0 if no error has occurred, 1 otherwise 1. + +## Syntax + +*object*.Position\(short nXPos, short nYPos\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *nXPos, nYPos*: new position of the window. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_xnb.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_xnb.md new file mode 100644 index 0000000000..754dc061fa --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_xnb.md @@ -0,0 +1,13 @@ +# XNb + +## Description + +Gets the number of pixels along the horizontal axis. + +## Syntax + +*object*.XNb\(\) As Short + +*object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_ynb.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_ynb.md new file mode 100644 index 0000000000..8dc373117a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/map_information/labvhv_ynb.md @@ -0,0 +1,13 @@ +# YNb + +## Description + +Gets the number of pixels along the vertical axis. + +## Syntax + +*object*.YNb\(\) As Short + +*object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_readability_and_visibility_analysis.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_readability_and_visibility_analysis.md new file mode 100644 index 0000000000..85c3dbb912 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_readability_and_visibility_analysis.md @@ -0,0 +1,4 @@ +# Readability and visibility analysis + +- [RelativeVisualPerformanceCIE1452002](labvhv_relativevisualperformancecie1452002.md) +- [Visibility](labvhv_visibility.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_relativevisualperformancecie1452002.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_relativevisualperformancecie1452002.md new file mode 100644 index 0000000000..5fb9ddef00 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_relativevisualperformancecie1452002.md @@ -0,0 +1,22 @@ +# RelativeVisualPerformanceCIE1452002 + +## Description + +Calculates the relative visual performance according to the CIE 145:2002 norm as a function of the background luminance, the target luminance and the target size. Returns a value between 0 and 1. + +## Syntax + +*object*.RelativeVisualPerformanceCIE1452002\(short nAge, double dLuminanceBackground, double dLuminanceTarget, double dTargetSize\) As Double + +- *object*: Virtual Human Vision Lab object + +- *nAge*: observer age \(input\) + +- *dLuminanceBackground*: background luminance in cd/m² as double \(input\) + +- *dLuminanceTarget*: target luminance in cd/m² \(input\) + +- *dTargetSize*: target size in inches \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_visibility.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_visibility.md new file mode 100644 index 0000000000..be58d762b4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/readability_and_visibility_analysis/labvhv_visibility.md @@ -0,0 +1,24 @@ +# Visibility + +## Description + +Evaluates the visibility of an object. Returns 0 is the object is visible, 1 otherwise. + +## Syntax + +object.Visibility\(short nAge, double dBackgroundluminance, double dTargetLuminance ,double dPreviousAdaptationLuminance, double dObservationTime\) As Short + +- *object*: Virtual Human Vision Lab object + +- *nAge*: observer age \(input\) + +- *dBackgroundluminance*: background luminance in cd/m² as double \(input\) + +- *dTargetLuminance*: target luminance in cd/m² \(input\) + +- *dPreviousAdaptationLuminance*: previous adaptation luminance in cd/m² \(input\) + +- *dObservationTime*: observation time in seconds \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_getmagnitude.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_getmagnitude.md new file mode 100644 index 0000000000..a7263bdc9a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_getmagnitude.md @@ -0,0 +1,56 @@ +# GetMagnitude + +## Description + +Gets the current measure magnitude. + +## Syntax + +- `object.GetMagnitude()` as Short +- *object*: Virtual Human Vision Lab +- *returned value*: + - 0: Default magnitude of the map + - 1: x color component, xyY color space + - 2: y color component, xyY color space + - 3: u color component, uvY color space + - 4: v color component, uvY color space + - 5: u' color component, u'v'Y color space + - 6: v' color component, u'v'Y color space + - 7: u\* color component, L\*u\*v\* color space + - 8: v\* color component, L\*u\*v\* color space + - 9: a\* color component, L\*a\*b\* color space + - 10: b\* color component, L\*a\*b\* color space + - 11: C\* color component, L\*C\*h color space + - 12: h color component, L\*C\*h color space + - 13: X color component, XYZ color space + - 14: Y color component, XYZ color space + - 15: Z color component, XYZ color space + - 16: L\* color component, L\*u\*v\* color space + - 17: Dimension + - 18: Glare + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Gets the current magnitude +result = VisionLabViewer.GetMagnitude() +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +#Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +#Gets the current magnitude +Retval = VisionLabViewer.GetMagnitude() +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_measuresexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_measuresexporttxt.md new file mode 100644 index 0000000000..9536e8061e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_measuresexporttxt.md @@ -0,0 +1,37 @@ +# MeasuresExportTXT + +## Description + +Exports the areas, measures and rules defined in the measures tool to a text file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.MeasuresExportTXT(BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *bstrFileName*: path and filename of the text \(.txt\) file + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports into TXT file +VisionLabViewer.MeasuresExportTXT("C:\Example.TXT") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports into TXT file +VisionLabViewer.MeasuresExportTXT ("C:\\Example.txt ") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_setmagnitude.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_setmagnitude.md new file mode 100644 index 0000000000..ec17e2862d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_setmagnitude.md @@ -0,0 +1,39 @@ +# SetMagnitude + +## Description + +Sets the current measure magnitude. Returns TRUE if the call has succeeded, FALSE otherwise. + +Caution: the current measure magnitude is reset to the default magnitude of the map during the execution of the OpenFile and AsyncOpenFile methods. + +## Syntax + +- `object.SetMagnitude(short iMagnitude)` as Boolean +- *object*: Virtual Human Vision Lab +- *iMagnitude*: index of the magnitude + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Sets the magnitude to X color component, XYZ color space +VisionLabViewer.SetMagnitude(13) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Sets the magnitude to X color component, XYZ color space +VisionLabViewer.SetMagnitude(13) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surface_calculation_on_map.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surface_calculation_on_map.md new file mode 100644 index 0000000000..c9b1dcdb0e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surface_calculation_on_map.md @@ -0,0 +1,13 @@ +# Surface calculation on map + +- [SurfaceLineExportTXT](labvhv_surfacelineexporttxt.md) +- [SurfacePolylineExportTXT](labvhv_surfacepolylineexporttxt.md) +- [GetMagnitude](labvhv_getmagnitude.md) +- [SetMagnitude](labvhv_setmagnitude.md) +- [MeasuresExportTXT](labvhv_measuresexporttxt.md) +- [SurfaceRectangleExportSpectrum](labvhv_surfacerectangleexportspectrum.md) +- [SurfaceEllipseExportSpectrum](labvhv_surfaceellipseexportspectrum.md) +- [SurfaceLineExportSpectrum](labvhv_surfacelineexportspectrum.md) +- [SurfacePointExportSpectrum](labvhv_surfacepointexportspectrum.md) +- [SurfacePolygonExportSpectrum](labvhv_surfacepolygonexportspectrum.md) +- [SurfacePolylineExportSpectrum](labvhv_surfacepolylineexportspectrum.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfaceellipseexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfaceellipseexportspectrum.md new file mode 100644 index 0000000000..884846c48f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfaceellipseexportspectrum.md @@ -0,0 +1,41 @@ +# SurfaceEllipseExportSpectrum + +## Description + +Exports the spectrum data of a measurement ellipse to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceEllipseExportSpectrum(double dXPos, double dYPos, double dWidth, double dHeight, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *dXPos*: horizontal coordinate of the center of the ellipse +- *dYPos*: vertical coordinate of the center of the ellipse +- *dWidth*: horizontal size of the ellipse +- *dHeight*: vertical size of the ellipse +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file. + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +VisionLabViewer.SurfaceEllipseExportSpectrum(0, 0, 0.25, 0.25, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +VisionLabViewer.SurfaceEllipseExportSpectrum(0, 0, 0.25, 0.25, "C:\\Example.spe") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacelineexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacelineexportspectrum.md new file mode 100644 index 0000000000..bb68aab9c6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacelineexportspectrum.md @@ -0,0 +1,41 @@ +# SurfaceLineExportSpectrum + +## Description + +Exports the spectrum data of a measurement line to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceLineExportSpectrum(double dXPos1, double dYPos1, double dXPos2, double dYPos2, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *dXPos1*: horizontal coordinate of the first vertex of the line +- *dYPos1*: vertical coordinate of the first vertex of the line +- *dXPos2*: horizontal coordinate of the second vertex of the line +- *dYPos2*: vertical coordinate of the second vertex of the line +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +VisionLabViewer.SurfaceLineExportSpectrum(-0.25, 0, 0.25, 0, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +VisionLabViewer.SurfaceLineExportSpectrum (-0.25, 0, 0.25, 0, "C:\\Example.spe") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacelineexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacelineexporttxt.md new file mode 100644 index 0000000000..e187fd5d60 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacelineexporttxt.md @@ -0,0 +1,42 @@ +# SurfaceLineExportTXT + +## Description + +Exports values of 2D section to text file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceLineExportTXT(double dXPos1, double dYPos1, double dXPos2, double dYPos2, int iSampling, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *dXPos1*: horizontal coordinate of the first vertex of the line +- *dYPos1*: vertical coordinate of the first vertex of the line +- *dXPos2*: horizontal coordinate of the second vertex of the line +- *dYPos2*: vertical coordinate of the second vertex of the line +- *iSampling*: number of measurements along the line +- *bstrFileName*: path and filename of the text file \(should end by .txt\). + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports values into TXT file +VisionLabViewer.SurfaceLineExportTXT(-4, -4, 4, 4, 50, "C:\Example.txt") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports values into TXT file +VisionLabViewer. SurfaceLineExportTxt(-4, -4, 4, 4, 50, "C:\\Example.txt ") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepointexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepointexportspectrum.md new file mode 100644 index 0000000000..edb569a057 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepointexportspectrum.md @@ -0,0 +1,39 @@ +# SurfacePointExportSpectrum + +## Description + +Exports the spectrum data of a measurement point to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePointExportSpectrum(double dXPos, double dYPos, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *dXPos*: horizontal coordinate of the point +- *dYPos*: vertical coordinate of the point +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +VisionLabViewer.SurfacePointExportSpectrum(0, 0, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +VisionLabViewer.SurfacePointExportSpectrum (0, 0, "C:\\Example.spe") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolygonexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolygonexportspectrum.md new file mode 100644 index 0000000000..a53b5ca226 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolygonexportspectrum.md @@ -0,0 +1,28 @@ +# SurfacePolygonExportSpectrum + +## Description + +Exports the spectrum data of a measurement polygon to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePolygonExportSpectrum(VARIANT* vPtX, VARIANT* vPtY, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polygon +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +vPtx = array(-0.3, 0.3, 0.3, -0.3) +vPty = array(-0.3, -0.3, 0.3, 0.3) +VisionLabViewer.SurfacePolygonExportSpectrum(vPtx, vPty, "C:\Example.spe") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolylineexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolylineexportspectrum.md new file mode 100644 index 0000000000..4197b3af1f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolylineexportspectrum.md @@ -0,0 +1,28 @@ +# SurfacePolylineExportSpectrum + +## Description + +Exports the spectrum data of a measurement polyline to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePolylineExportSpectrum(VARIANT* vPtX, VARIANT* vPtY, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polyline +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polyline +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +vPtx = array(-0.3, 0.3, 0.3, -0.3) +vPty = array(-0.3, -0.3, 0.3, 0.3) +VisionLabViewer.SurfacePolylineExportSpectrum(vPtx, vPty, "C:\Example.spe") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolylineexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolylineexporttxt.md new file mode 100644 index 0000000000..b41a7f0d31 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacepolylineexporttxt.md @@ -0,0 +1,29 @@ +# SurfacePolylineExportTXT + +## Description + +Exports values of 2D polyline to a text file format. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePolylineExportTXT(VARIANT* vPtX, VARIANT* vPtY, int iSampling, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polyline +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polyline +- *iSampling*: number of measurements along the polyline +- *bstrFileName*: path and filename of the text \(.txt\) file. + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports values into TXT file +vPtx = array(-4, -4, 4, 4) +vPty = array(-4, 4, -4, 4) +VisionLabViewer.SurfacePolylineExportTXT(vPtx, vPty, 50, "C:\Example.txt") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacerectangleexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacerectangleexportspectrum.md new file mode 100644 index 0000000000..0beb60be93 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_human_vision_lab/surface_calculation_on_map/labvhv_surfacerectangleexportspectrum.md @@ -0,0 +1,41 @@ +# SurfaceRectangleExportSpectrum + +## Description + +Exports the spectrum data of a measurement rectangle to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceRectangleExportSpectrum(double dXPos, double dYPos, double dWidth, double dHeight, BSTR bstrFileName)` as Boolean +- *object*: Virtual Human Vision Lab +- *dXPos*: horizontal coordinate of the center of the rectangle +- *dYPos*: vertical coordinate of the center of the rectangle +- *dWidth*: horizontal size of the rectangle +- *dHeight*: vertical size of the rectangle +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file. + +## VB script example + +```VB +' Creates VisionLabViewer COM server +set VisionLabViewer = CreateObject("VisionLabViewer.application") +' Opens XMP file +VisionLabViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +VisionLabViewer.SurfaceRectangleExportSpectrum(0, 0, 0.5, 0.5, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates VisionLabViewer COM server +type = Type.GetTypeFromProgID("VisionLabViewer.Application") +VisionLabViewer = Activator.CreateInstance(type) +# Opens XMP file +VisionLabViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +VisionLabViewer.SurfaceRectangleExportSpectrum ( 0, 0, 0.5, 0.5, "C:\\Example.spe") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_basic_methods.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_basic_methods.md new file mode 100644 index 0000000000..8b82f9bd64 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_basic_methods.md @@ -0,0 +1,16 @@ +# Basic methods + +- [ImportTemplate](labvp_importtemplate.md) +- [ExportTemplate](labvp_exporttemplate.md) +- [MapType](labvp_maptype.md) +- [OpenFile](labvp_openfile.md) +- [ReturnUnitType](labvp_returnunittype.md) +- [ReturnValueType](labvp_returnvaluetype.md) +- [SaveFile](labvp_savefile.md) +- [SetColorMode](labvp_setcolormode.md) +- [SetReturnUnitType](labvp_setreturnunittype.md) +- [UnitType](labvp_unittype.md) +- [ValueType](labvp_valuetype.md) +- [GetIntensityType](labvp_getintensitytype.md) +- [GetAxisUnitName](labvp_getaxisunitname.md) +- [GetPID](labvp_getpid.md) diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_exporttemplate.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_exporttemplate.md new file mode 100644 index 0000000000..9c0566574a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_exporttemplate.md @@ -0,0 +1,35 @@ +# ExportTemplate + +## Description + +Exports a template into a .xml format. Returns TRUE is the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExportTemplate(BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *bstrFileName*: path and filename of the template \(should end by .XML\) + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports template +XMPViewer.ExportTemplate("C:\Example.xml") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports template +XmpViewer.ExportTemplate ("C:\\Example.xml") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getaxisunitname.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getaxisunitname.md new file mode 100644 index 0000000000..aeb79fd822 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getaxisunitname.md @@ -0,0 +1,47 @@ +# GetAxisUnitName + +## Description + +Returns the storage axis unit of grid \(degree, radian, metre, millimetre, etc.\). + +## Syntax + +- `object.GetAxisUnitName()` as String +- *object*: Virtual Photometric Lab +- *returned value*: + - meter + - centimeter + - millimeter + - micrometer + - nanometer + - feet + - inch + - degree + - radian + - milliradian + - arc minute + - arc second + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Gets Axis Unit Name +result = XMPViewer.GetAxisUnitName() +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Gets axis unit name +Retval = XmpViewer.GetAxisUnitName() +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getintensitytype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getintensitytype.md new file mode 100644 index 0000000000..bfc5c0ebd3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getintensitytype.md @@ -0,0 +1,43 @@ +# GetIntensityType + +## Description + +Returns the intensity type of the map \(Optis, SAE type A, SAE type B, Conoscopic\). + +## Syntax + +- `object.GetIntensityType()` as Short +- *object*: Virtual Photometric Lab object +- *returned value*: + - -1: Unknown + - 0: OptisIntensityOptis + + **Note:** The OPTIS Intensity XMP map type is in end of life as of version 2023 R2, and no longer available in the user interface + + - 1: OptisIntensitySAETypeA + - 2: OptisIntensitySAETypeB + - 3: OptisIntensityConoscopic + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Gets Intensity Type +result = XMPViewer.GetIntensityType() +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Gets intensity type +Retval = XmpViewer.GetIntensityType() +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getpid.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_importtemplate.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_importtemplate.md new file mode 100644 index 0000000000..464f14f732 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_importtemplate.md @@ -0,0 +1,54 @@ +# ImportTemplate + +## Description + +Imports a template and applies it to the current map. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +object.ImportTemplate\(BSTR bstrFileName, short bDisplayOptions, short bMeasures, short bAreasToMap\) as Boolean + +- *object*: Virtual Photometric Lab / Virtual Human Vision Lab object + +- *bstrFileName*: template filename \(.xml\) + +- *bDisplayOptions*: 1 to apply display options, 0 otherwise + +- *bMeasures*: 1 to apply measures, 0 otherwise + +- *bAreasToMap*: 1 to adjust areas to map, 0 otherwise + + +## VB script example + +```VB +Sub TestLab() +' Starts the application +Dim Viewer +Set Viewer = CreateObject("XMPViewer.Application") +' Opens a file +Dim MyVar +MyVar = Viewer.OpenFile("C:\tmp\XMPViewer\Exemple.xmp") +' Imports a template +Dim RetVal +RetVal = Viewer.ImportTemplate("C:\tmp\XMPViewer\Exemple.xml", 1, 1, 0) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +# Imports a template +MyTemplateFile = ("C:\\tmp\\XMPViewer\\Exemple.xml") +XMPViewer.ImportTemplate(MyTemplateFile, 1, 1, 0) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_maptype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_maptype.md new file mode 100644 index 0000000000..851b918fd1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_maptype.md @@ -0,0 +1,32 @@ +# MapType + +## Description + +Gets the type of map. + +## Syntax + +*object*.MapType\(\) As Short + +- *object*: Virtual Photometric Lab object + +- Returned value: + + 0 : OptisMapTypeBasic + + 1 : OptisMapTypeLaser + + 2 : OptisMapTypeSpectral + + 3 : OptisMapTypeExtended + + 4 : OptisMapTypeUnknown + + 5 : OptisMapTypeGainMatrix + + 6 : OptisMapTypeRays + + 7 : OptisMapTypeFTM + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_openfile.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_openfile.md new file mode 100644 index 0000000000..23aa2fb805 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_openfile.md @@ -0,0 +1,16 @@ +# OpenFile + +## Description + +Opens a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string including path \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_returnunittype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_returnunittype.md new file mode 100644 index 0000000000..241f04b27a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_returnunittype.md @@ -0,0 +1,36 @@ +# ReturnUnitType + +## Description + +Returns the unit type of the map. + +## Syntax + +*object*.ReturnUnitType\(\) As Short + +- *object*: Virtual Photometric Lab object + +- Return value: + + 0: radiometric + + 1: photometric + + 2: gain + + 3: unknown + + 4: FTM + + 5: degree + + 6: inverse meter + + 7: inverse square meter + + 8: percent + + 9: diopter + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_returnvaluetype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_returnvaluetype.md new file mode 100644 index 0000000000..a9d9fb36ce --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_returnvaluetype.md @@ -0,0 +1,60 @@ +# ReturnValueType + +## Description + +Returns the value type of the map. + +## Syntax + +*object*.ReturnValueType\(\) As Short + +- *object*: Virtual Photometric Lab object + +- Return value: + + 0: irradiance + + 1: intensity + + 2: radiance + + 3: visual + + 4: SEL + + 5: laser phase + + 6: laser phase plane + + 7: directional irradiance + + 8: gain + + 9: wavefront + + 10: FTM + + 11: RP + + 12: power density + + 13: population + + 14: temperature + + 15: angle + + 16: curvature + + 17: curvature product + + 18: percentage + + 19: unknown + + 20: refractive power + + 21: fly through + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_savefile.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_savefile.md new file mode 100644 index 0000000000..9109ec9e9d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_savefile.md @@ -0,0 +1,16 @@ +# SaveFile + +## Description + +Saves a file. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR bstrFileName\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: filename string \(input\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_setcolormode.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_setcolormode.md new file mode 100644 index 0000000000..5cc9b132ae --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_setcolormode.md @@ -0,0 +1,38 @@ +# SetColorMode + +## Description + +Sets the color mode of the map. + +## Syntax + +*object*.SetColorMode\(short nColorMode\) As Short + +- *object*: Virtual Photometric Lab object + +- *nColorMode*: color mode to set + + 0: OptisFalseColorModeBlackToWhiteWithColor + + 1: OptisFalseColorModeWhiteToBlackWithColor + + 2: OptisFalseColorModeBlackToWhiteWithGray + + 3: OptisFalseColorModeWhiteToBlackWithGray + + 4: OptisFalseColorModeBlueToRed + + 5: OptisFalseColorModeRedToBlue + + 6: OptisTrueColorMode + + 7: OptisFalseColorModeRedLevels + + 8: OptisFalseColorModeGreenLevels + + 9: OptisFalseColorModeBlueLevels + + 10:OptisFalseColorModeIso + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_setreturnunittype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_setreturnunittype.md new file mode 100644 index 0000000000..1efa785d9a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_setreturnunittype.md @@ -0,0 +1,16 @@ +# SetReturnUnitType + +## Description + +Allows you to modify the unit of a map and to convert data from photometric to radiometric during the export of a spectral map in an extended map. + +## Syntax + +*object*.SetReturnUnitType\(short iReturnUnitType\); As Short + +- *object*: Virtual Photometric Lab object + +- *iReturnUnitType*: returned unit type between OptisUnitTypeRadiometric = 0 and OptisUnitTypePhotometric = 1 + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_unittype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_unittype.md new file mode 100644 index 0000000000..2190b70f8f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_unittype.md @@ -0,0 +1,34 @@ +# UnitType + +## Description + +Gets the unit type of the map data. + +## Syntax + +*object*.UnitType\(\) As Short + +- *object*: Virtual Photometric Lab object + +- Returned value: + + 0: OptisUnitTypeRadiometric + + 1: OptisUnitTypePhotometric + + 2: OptisUnitTypeGain + + 3: OptisUnitTypeUnknown + + 4: OptisUnitTypeFTM + + 5: OptisUnitTypeDegree + + 6: OptisUnitTypeInverseMeter + + 7: OptisUnitTypeInverseSquareMeter + + 8: OptisUnitTypePercent + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_valuetype.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_valuetype.md new file mode 100644 index 0000000000..fe1a5eab98 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/basic_methods/labvp_valuetype.md @@ -0,0 +1,56 @@ +# ValueType + +## Description + +Gets the value type of the map data. + +## Syntax + +*object*.ValueType\(\) As Short + +- *object*: Virtual Photometric Lab object + +- Returned value: + + 0: OptisValueTypeIrradiance + + 1: OptisValueTypeIntensity + + 2: OptisValueTypeRadiance + + 3: OptisValueTypeVisual + + 4: OptisValueTypeSel + + 5: OptisValueTypeLaserPhase + + 6: OptisValueTypeLaserPhasePlane + + 7: OptisValueTypeDirectionalIrradiance + + 8: OptisValueTypeGain + + 9: OptisValueTypeWaveFront + + 10: OptisValueTypeFTM + + 11: OptisValueTypeRP + + 12: OptisValueTypePowerDensity + + 13: OptisValueTypePopulation + + 14: OptisValueTypeTemperature + + 15: OptisValueTypeAngle + + 16: OptisValueTypeCurvature + + 17: OptisValueTypeCurvatureProduct + + 18: OptisValueTypePercentage + + 19: OptisValueTypeUnknown + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_color_rendering_index.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_color_rendering_index.md new file mode 100644 index 0000000000..6fa0e5c95b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_color_rendering_index.md @@ -0,0 +1,6 @@ +# Color rendering index + +- [GetSampleCRI](labvp_getsamplecri.md) +- [SurfaceRectangleSampleCRI](labvp_surfacerectanglesamplecri.md) +- [SurfaceEllipseSampleCRI](labvp_surfaceellipsesamplecri.md) +- [SurfacePolygonSampleCRI](labvp_surfacepolygonsamplecri.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_getsamplecri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_getsamplecri.md new file mode 100644 index 0000000000..1f69be1bae --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_getsamplecri.md @@ -0,0 +1,59 @@ +# GetSampleCRI + +## Description + +Gets the individual Color Rendering Index value of a point. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object.GetSampleCRI\(double dX, double dY, short nSampleNumber, VARIANT\* vdCRI\)* + +- *object*: XMPViewer object + +- *dX*: x coordinate of the point. + +- *dY*: y coordinate of the point. + +- *nSampleNumber*: sample number \(from 1 to 15\). + +- *vdCRI*\(pointer on result\): VARIANT of type VT\_R8 \(double\). + + +## VB script example + +```VB +Sub CRISample () +'Error Management +Dim Error As Integer +'Declares XMPViewer +Dim Viewer As Object +Set Viewer = CreateObject("XmpViewer.Application ") +'Shows XMPViewer +Viewer.Show(1) +'Opens File +Error = Viewer.OpenFile("C:\temp\Spectral.xmp ") +' Gets first sample CRI for point (1, 2) +Dim RetCRI +Error = Viewer.GetSampleCRI(1, 2, 1, RetCRI) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +# Show the secondary grid +XMPViewer. ShowSecondaryGrid(True) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfaceellipsesamplecri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfaceellipsesamplecri.md new file mode 100644 index 0000000000..d35af86eb1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfaceellipsesamplecri.md @@ -0,0 +1,49 @@ +# SurfaceEllipseSampleCRI + +## Description + +Gets the individual Color Rendering Index value of an ellipse. + +Fails with a conoscopic map. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object.SurfaceEllipseSampleCRI \(double dX, double dY, double dWidth, double dHeight, short nSampleNumber, VARIANT\* vdCRI\)* + +*object*: XMPViewer object + +*dX*: x coordinate of the ellipse center. + +*dY*: y coordinate of the ellipse center. + +*dWidth*: width of the ellipse. + +*dHeight*: height of the ellipse. + +*nSampleNumber*: sample number \(from 1 to 15\). + +*vdCRI*\(pointer on result\): VARIANT of type VT\_R8 \(double\). + +## Example + +``` +Sub CRISample () +'Error Management +Dim Error As Integer +'Declares XMPViewer +Dim Viewer As Object +Set Viewer = CreateObject("XmpViewer.Application ") +'Shows XMPViewer +Viewer.Show(1) +'Opens File +Error = Viewer.OpenFile("C:\temp\Spectral.xmp ") +' Gets first sample CRI for ellipse +Dim RetCRI +Error = Viewer.SurfaceEllipseSampleCRI(1, 2, 10, 10, 1, RetCRI) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfacepolygonsamplecri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfacepolygonsamplecri.md new file mode 100644 index 0000000000..6916a972cc --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfacepolygonsamplecri.md @@ -0,0 +1,48 @@ +# SurfacePolygonSampleCRI + +## Description + +Gets the individual Color Rendering Index value of a polygon. + +Fails with a conoscopic map. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object.SurfacePolygonSampleCRI\(VARIANT\* vPtX, VARIANT\* vPtY, short nSampleNumber, VARIANT\* vdCRI\)* + +- *object*: XMPViewer object + +- *vPtX*: array of x coordinates of the polygon. + +- *vPtY*: array of y coordinates of the polygon. + +- *nSampleNumber*: sample number \(from 1 to 15\). + +- *vdCRI*\(pointer on result\): VARIANT of type VT\_R8 \(double\). + + +## Example + +``` +Sub CRISample () +'Error Management +Dim Error As Integer +'Declares XMPViewer +Dim Viewer As Object +Set Viewer = CreateObject("XmpViewer.Application ") +'Shows XMPViewer +Viewer.Show(1) +'Opens File +Error = Viewer.OpenFile("C:\temp\Spectral.xmp ") +' Gets first sample CRI for polygon +PointsX = array(-9, 11, 11, -9) +PointsY = array(-8, -8, 12, 12) +Dim RetCRI +Error = Viewer.SurfacePolygonSampleCRI(PointsX, PointsY, 1, RetCRI) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfacerectanglesamplecri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfacerectanglesamplecri.md new file mode 100644 index 0000000000..76dce971b1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/color_rendering_index/labvp_surfacerectanglesamplecri.md @@ -0,0 +1,48 @@ +# SurfaceRectangleSampleCRI + +## Description + +Gets individual Color Rendering Index value of a rectangle \(or corona if conoscopic map\). + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object.SurfaceRectangleSampleCRI\(double dX, double dY, double dWidth, double dHeight, short nSampleNumber, VARIANT\* vdCRI\)* + +- *object*: XMPViewer object + +- *dX*: x coordinate of the rectangle center. + +- *dY*: y coordinate of the rectangle center. + +- *dWidth*: width of the rectangle. + +- *dHeight*: height of the rectangle. + +- *nSampleNumber*: sample number \(from 1 to 15\). + +- *vdCRI*\(pointer on result\): VARIANT of type VT\_R8 \(double\). + + +## Example + +``` +Sub CRISample () +'Error Management +Dim Error As Integer +'Declares XMPViewer +Dim Viewer As Object +Set Viewer = CreateObject("XmpViewer.Application ") +'Shows XMPViewer +Viewer.Show(1) +'Opens File +Error = Viewer.OpenFile("C:\temp\Spectral.xmp ") +' Gets first sample CRI for rectangle +Dim RetCRI +Error = Viewer.SurfaceRectangleSampleCRI(1, 2, 10, 10, 1, RetCRI) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_createmap.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_createmap.md new file mode 100644 index 0000000000..9fd881b88f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_createmap.md @@ -0,0 +1,20 @@ +# CreateMap + +## Description + +Creates a new extended map. Returns 1 when succeeded and 0 when failed. + +## Syntax + +*object*.CreateMap\(int iMapType, int iUnitType, int iValueType\) As Short + +- *object*: Virtual Photometric Lab object + +- *iMapType*: See MapType\(\) method + +- *iUnitType*: See UnitType\(\) method + +- *iValueType*: See ValueType\(\) method + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_creating_a_new_map.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_creating_a_new_map.md new file mode 100644 index 0000000000..16752a791b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_creating_a_new_map.md @@ -0,0 +1,8 @@ +# Creating a new map + +- [CreateMap](labvp_createmap.md) +- [ImportTXT](labvp_importtxt.md) +- [SetXMax](labvp_setxmax.md) +- [SetXMin](labvp_setxmin.md) +- [SetYMax](labvp_setymax.md) +- [SetYMin](labvp_setymin.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_importtxt.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_importtxt.md new file mode 100644 index 0000000000..e2047f65f7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_importtxt.md @@ -0,0 +1,16 @@ +# ImportTXT + +## Description + +Imports the text file and returns 1 if the call succeeds, 0 otherwise. + +## Syntax + +*object*.ImportTXT\(BSTR bstrFileName\) As Short + +- *object*: Virtual Photometric Lab object + +- *bstrFileName*: text file name + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setxmax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setxmax.md new file mode 100644 index 0000000000..99cb27afd9 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setxmax.md @@ -0,0 +1,16 @@ +# SetXMax + +## Description + +Sets the horizontal coordinate of the right edge of the map and returns 0. + +## Syntax + +*object*.SetXMax\(double dXMax\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXMax*: value to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setxmin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setxmin.md new file mode 100644 index 0000000000..6cb952ca5b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setxmin.md @@ -0,0 +1,16 @@ +# SetXMin + +## Description + +Sets the horizontal coordinate of the left edge of the map and returns 0. + +## Syntax + +*object*.SetXMin\(double dXMin\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXMin*: value to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setymax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setymax.md new file mode 100644 index 0000000000..455773a2bb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setymax.md @@ -0,0 +1,16 @@ +# SetYMax + +## Description + +Return value: sets the vertical coordinate of the top edge of the map and returns 0. + +## Syntax + +*object*.SetYMax\(double dYMax\) As Short + +- *object*: Virtual Photometric Lab object + +- *dYMax*: value to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setymin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setymin.md new file mode 100644 index 0000000000..3832599133 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/create_new_map/labvp_setymin.md @@ -0,0 +1,16 @@ +# SetYMin + +## Description + +Return value: sets the vertical coordinate of the bottom edge of the map and returns 0. + +## Syntax + +*object*.SetYMin\(double dYMin\) As Short + +- *object*: Virtual Photometric Lab object + +- *dYMin*: value to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportchart3d.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportchart3d.md new file mode 100644 index 0000000000..cf80a60b92 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportchart3d.md @@ -0,0 +1,18 @@ +# ExportChart3D + +## Description + +Saves the 3D ISO image display of the map including the legend in a **.oc3** file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportChart3D\(BSTR bstrFileName, int iWidth\) As Short + +- *object*: Virtual Photometric Lab object + +- *bstrFileName*: file name to save the image + +- *iWidth*: maximal horizontal number of pixels + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportchart3d3d.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportchart3d3d.md new file mode 100644 index 0000000000..996aa952b5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportchart3d3d.md @@ -0,0 +1,18 @@ +# ExportChart3D3D + +## Description + +Saves the 3D ISO image display of the map in a **.oc3** file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportChart3D3D\(BSTR bstrFileName, int iWidth\) As Short + +- *object*: Virtual Photometric Lab object + +- *bstrFileName*: file name to save the image + +- *iWidth*: maximal horizontal number of pixels + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exporting_data.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exporting_data.md new file mode 100644 index 0000000000..044c3f9ee7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exporting_data.md @@ -0,0 +1,12 @@ +# Exporting data + +- [ExportChart3D](labvp_exportchart3d.md) +- [ExportChart3D3D](labvp_exportchart3d3d.md) +- [ExportTXT](labvp_exporttxt.md) +- [ExportPF](labvp_exportpf.md) +- [ExportXMP](labvp_exportxmp.md) +- [ExportXMPtoIntensity](labvp_exportxmptointensity.md) +- [ExportXMPImage](labvp_exportxmpimage.md) +- [ExportXMPtoResizedImage](labvp_exportxmptoresizedimage.md) +- [ExportXMPIso](labvp_exportxmpiso.md) +- [ExportXMPtoHDRI](labvp_exportxmptohdri.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportpf.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportpf.md new file mode 100644 index 0000000000..a4e03415ff --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportpf.md @@ -0,0 +1,16 @@ +# ExportPF + +## Description + +Saves the map data in a pf file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportPF\(BSTR bstrFileName\) As Short + +- *object*: Virtual Photometric Lab object + +- *bstrFileName*: filename to save the pf file + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exporttxt.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exporttxt.md new file mode 100644 index 0000000000..fbff36eaa8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exporttxt.md @@ -0,0 +1,16 @@ +# ExportTXT + +## Description + +Saves the map data in a Text file. Returns a value different from 0 if no error has occurred. + +To export extended and spectral maps as a text file, refer to [ExtendedExportTXT](../extended_and_spectral_map/labvp_extendedexporttxt.md). + +## Syntax + +*object*.ExportTXT\(BSTR bstrFileName\) As Short + +- *object*: Virtual Photometric Lab object +- *bstrFileName*: filename to save the image + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmp.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmp.md new file mode 100644 index 0000000000..431f1475ed --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmp.md @@ -0,0 +1,28 @@ +# ExportXMP + +## Description + +Saves the map data in a xmp file. + +## Syntax + +*object*.ExportXMP\(LPSTR strFileName, short bIncludeSpectralData, short bMergeActiveSources, short bExportFilteredData, short bExtendedMapConversion, \[optional\] short bToConoscopicLuminance, \[optional\] double dSurface\) As Short + +- *object*: Virtual Photometric Lab object + +- *strFileName*: filename to save the xmp file + +- *bIncludeSpectralData*: 1 to include spectral data, 0 otherwise + +- *bMergeActiveSources*: 1 to merge active sources, 0 otherwise + +- *bExportFilteredData*: 1 to export filtered data, 0 otherwise + +- *bExtendedMapConversion*: 1 to convert to extended ma, 0 otherwise + +- *bToConoscopicLuminance*: optional, 1 to export conoscopic intensity map as luminance map, 0 otherwise + +- *dSurface*: surface used to convert intensity values in luminance \(m2\). + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmpimage.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmpimage.md new file mode 100644 index 0000000000..c1e8cfdc3f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmpimage.md @@ -0,0 +1,18 @@ +# ExportXMPImage + +## Description + +Saves the image display of the map in a file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportXMPImage\(BSTR bstrFileName, int iFormat\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: file name to save the image + +- *iFormat*: image format \(0: BMP, 1: PNG, 2 :TIFF, 3: JPG\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmpiso.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmpiso.md new file mode 100644 index 0000000000..46f6a0d769 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmpiso.md @@ -0,0 +1,26 @@ +# ExportXMPIso + +## Description + +Saves the 2D ISO image display of the map in a file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportXMPIso\(BSTR bstrFileName, int iMaxSize, int iFormat, int bLegend, int bContour, int iNbLevel\) As Short + +- *object*: Virtual Photometric Lab object + +- *bstrFileName*: file name to save the image + +- *iMaxSize*: maximal horizontal or vertical number of pixels + +- *iFormat*: image format \(0: BMP, 3: JPG, 4: PNG\) + +- *bLegend*: A value different than 0 for including the legend + +- *bContour*: A value different than 0 for including the contour + +- *iNbLevel*: number of ISO levels + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptohdri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptohdri.md new file mode 100644 index 0000000000..910d188150 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptohdri.md @@ -0,0 +1,18 @@ +# ExportXMPtoHDRI + +## Description + +Exports a XMP map as HDRI file. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.ExportXMPtoHDRI\(string bstrFileName, integer iFormat\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bstrFileName*: path and filename of the HDRI. Should end by **.hdr** for RGBE files, **.exr** for OpenEXR files. + +- *iFormat*: format of the output file, 0 for OpenEXR, 1 for RGBE. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptointensity.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptointensity.md new file mode 100644 index 0000000000..77d9c19081 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptointensity.md @@ -0,0 +1,41 @@ +# ExportXMPtoIntensity + +## Description + +Exports an intensity XMP map to IES or Eulumdat file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExportXMPtoIntensity(BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab object +- *bstrFileName*: path and filename of the IES or Eulumdat \(filenames should end by .IES or .LDT\). + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' ExportXMPtoIntensity with LDT extension +XMPViewer.ExportXMPtoIntensity(C:\Example.LDT") +' ExportXMPtoIntensity with IES extension +XMPViewer.ExportXMPtoIntensity("C:\Example.IES") +``` + +## IronPython example + +``` +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# ExportXMPtoIntensity with LDT extension +XmpViewer.ExportXMPtoIntensity ("C:\\Example.ldt") +# ExportXMPtoIntensity with IES extension +XmpViewer.ExportXMPtoIntensity ("C:\\Example.ies") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptoresizedimage.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptoresizedimage.md new file mode 100644 index 0000000000..14f8ddd60e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/exporting_data/labvp_exportxmptoresizedimage.md @@ -0,0 +1,42 @@ +# ExportXMPtoResizedImage + +## Description + +Exports the current view of an XMP map as an image \(based on the current display settings and size specifications\). + +Returns TRUE if the call has succeeded, FALSE otherwise. + +**Note:** For high ratio values, the function can return FALSE. + +## Syntax + +- `object.ExportXMPtoResizedImage(BSTR bstrFileName, double ratio)` as Boolean +- *object*: Virtual Photometric Lab +- *bstrFileName*: path and filename of the BMP, PNG, TIFF or JPG. Should end by **.BMP**, **.PNG**, **.TIFF** or **.JPG**. +- *ratio*: ratio \(multiplication factor\) applied to the exported image. Should be greater than 0 and comprised between 0.001 and 100. + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports the XMP map +XMPViewer.ExportXMPtoResizedImage("C:\Example.png", 10) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports XMP map +retval = XmpViewer.ExportXMPtoResizedImage("C:\\Example.png", 10) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extended_and_spectral_map.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extended_and_spectral_map.md new file mode 100644 index 0000000000..a76befffbf --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extended_and_spectral_map.md @@ -0,0 +1,20 @@ +# Extended and spectral map + +- [ExtendedExportTXT](labvp_extendedexporttxt.md) +- [ExtendedGetNbConfig](labvp_extendedgetnbconfig.md) +- [ExtendedGetNbSource](labvp_extendedgetnbsource.md) +- [ExtendedSetSourceName](labvp_extendedsetsourcename.md) +- [ExtendedGetSourceName](labvp_extendedgetsourcename.md) +- [ExtendedSetConfigName](labvp_extendedsetconfigname.md) +- [ExtendedGetConfigName](labvp_extendedgetconfigname.md) +- [ExtendedCreateConfig](labvp_extendedcreateconfig.md) +- [ExtendedSetActiveConfig](labvp_extendedsetactiveconfig.md) +- [ExtendedSetActiveSource](labvp_extendedsetactivesource.md) +- [ExtendedSetSourceRatio](labvp_extendedsetsourceratio.md) +- [ExtendedGetSourceRatio](labvp_extendedgetsourceratio.md) +- [ExtendedActivateSourceLayer](labvp_extendedactivatesourcelayer.md) +- [SpectralGetActiveWavelength](labvp_spectralgetactivewavelength.md) +- [SpectralGetNbWavelength](labvp_spectralgetnbwavelength.md) +- [SpectralSetActiveWavelength](labvp_spectralsetactivewavelength.md) +- [SpectralSpectrumChange](labvp_spectralspectrumchange.md) +- [WriteSpectralTable](labvp_writespectraltable.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedactivatesourcelayer.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedactivatesourcelayer.md new file mode 100644 index 0000000000..0da059d1e4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedactivatesourcelayer.md @@ -0,0 +1,27 @@ +# ExtendedActivateSourceLayer + +## Description + +Activates one source of an extended map. + +In case of error, returns -1 if: + +- no source in the map + +- iSource \>= number of sources in the map + +- iSource < 0 + + +## Syntax + +*object*.ExtendedActivateSourceLayer\(int iSource, bool bActive\) As Short + +- *object*: Virtual Photometric Lab or Human Vision Lab object + +- *iSource*: index of the source to consider + +- *bActive*: true to activate the source, false to deactivate it + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedcreateconfig.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedcreateconfig.md new file mode 100644 index 0000000000..015e657c7c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedcreateconfig.md @@ -0,0 +1,39 @@ +# ExtendedCreateConfig + +## Description + +Creates a new configuration. The name of the new configuration has to be specified in the creation method. The name of the new configuration must be unique and not empty. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedCreateConfig(BSTR bstrConfigName)` as Boolean +- *object*: Virtual Photometric Lab +- *bstrConfigName*: name of the configuration + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Creates a new configuration +XMPViewer.ExtendedCreateConfig("My Configuration") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XmpViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Creates a new configuration +XmpViewer.ExtendedCreateConfig("My Configuration") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedexporttxt.md new file mode 100644 index 0000000000..1ceb94d8da --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedexporttxt.md @@ -0,0 +1,19 @@ +# ExtendedExportTXT + +## Description + +Exports extended and spectral maps as a text file. + +## Syntax + +*object*.ExtendedExportTXT\(BSTR bstrFileName, Int bExportDataByLayer\) As Integer + +- *object*: Virtual Photometric Lab object +- *bstrFileName*: text file name +- *bExportDataByLayer*: 0 to export the active configuration, 1 to export data by layer + +## Remark + +The method only works for non spectral map. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetconfigname.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetconfigname.md new file mode 100644 index 0000000000..e49a934155 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetconfigname.md @@ -0,0 +1,48 @@ +# ExtendedGetConfigName + +## Description + +Gets the name of the configuration number N. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedGetConfigName(int iConfig, VARIANT* ovConfigName)` as Boolean +- *object*: Virtual Photometric Lab +- *iConfig*: index of the configuration in Virtual Lighting Controller \(starting from 0\) +- *ovConfigName*: name of the configuration + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Gets the name of the configuration #3 +Dim sConfigName +XMPViewer.ExtendedGetConfigName(3, sConfigName) +' Prints the name of the configuration #3 +Dim ConfigName As String +ConfigName = sConfigName(1) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Gets the name of the configuration number 3 +sConfigName = clr.Reference[System.Object]() #Creates a default pointer +retval = XmpViewer.ExtendedGetConfigName(2, sConfigName) +# Prints the name of the configuration number 3 +configName = sConfigName.Value +print configName[0] +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetnbconfig.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetnbconfig.md new file mode 100644 index 0000000000..c9dc492769 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetnbconfig.md @@ -0,0 +1,14 @@ +# ExtendedGetNbConfig + +## Description + +Returns the number of configurations defined for the Layers Operations. + +## Syntax + +*object*.ExtendedGetNbConfig\(\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetnbsource.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetnbsource.md new file mode 100644 index 0000000000..9fccdac292 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetnbsource.md @@ -0,0 +1,14 @@ +# ExtendedGetNbSource + +## Description + +Returns the number of sources of an extended or a spectral map \(0 if the map is not an extended or a spectral map\). + +## Syntax + +*object*.ExtendedGetNbSource\(\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetsourcename.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetsourcename.md new file mode 100644 index 0000000000..d60a2b4a67 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetsourcename.md @@ -0,0 +1,83 @@ +# ExtendedGetSourceName + +## Description + +Gets the name of the source number N. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedGetSourceName(int iSource, VARIANT* ovSourceName)` as Boolean +- *object*: Virtual Photometric Lab +- *iSource*: index of the source in Virtual Lighting Controller \(starting from 0\) +- *ovSourceName*: name of the source + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Gets the name of the source #3 +Dim sSourceName +XMPViewer.ExtendedGetSourceName(3, sSourceName) +' Prints the name of the source #3 +Dim SourceName As String +SourceName = sSourceName(1) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Gets the name of the source number 3 +sSourceName = clr.Reference[System.Object]() #Creates a default pointer +retval = XmpViewer.ExtendedGetSourceName(2, sSourceName) +# Prints the name of the source number 3 +sourceName = sSourceName.Value +print sourceName[0] +``` + +## C\# example + +``` +//Opens XMP file + XMPViewer.OpenFile(xmpmapPath); + + //Returns the number of sources of the XMP file + int iNbSource = viewer.ExtendedGetNbSource(); + if (iNbSource == 0) + Console.WriteLine("Error in ExtendedGetNbSource"); + + for (int sourceindex = 0; sourceindex < iNbSource; sourceindex++) + { + object objSourceName = null; + int RetVal = viewer.ExtendedGetSourceName(sourceindex, ref objSourceName); + + if (RetVal == 0) + { + Console.WriteLine("Error in ExtendedGetSourceName"); + } + + //Get String Data in objSourceName Result + if (objSourceName is ICollection collection) + { + foreach (var item in collection) + { + if (item is string str) + { + Console.WriteLine(str); + } + } + } + } +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetsourceratio.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetsourceratio.md new file mode 100644 index 0000000000..106dc6827c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedgetsourceratio.md @@ -0,0 +1,27 @@ +# ExtendedGetSourceRatio + +## Description + +Gets the value of one of the sources of an extended or a spectral map. + +In case of error, returns -1 if: + +- the map is neither an extended nor a spectral map + +- no source in the map + +- iSource \>= number of sources in the map + +- iSource < 0 + + +## Syntax + +*object*.ExtendedGetSourceRatio\(int iSource\) As Double + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetactiveconfig.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetactiveconfig.md new file mode 100644 index 0000000000..47929307e8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetactiveconfig.md @@ -0,0 +1,16 @@ +# ExtendedSetActiveConfig + +## Description + +Sets the active configuration for the Layers Operations. + +## Syntax + +*object*.ExtendedSetActiveConfig\(int nConfig\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *nConfig*: configuration index + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetactivesource.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetactivesource.md new file mode 100644 index 0000000000..828a8de55c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetactivesource.md @@ -0,0 +1,15 @@ +# ExtendedSetActiveSource + +## Description + +Sets the active source of an extended or a spectral map \(0 if the map is not an extended or a spectral map\). + +## Syntax + +*object*.ExtendedSetActiveSource\(int iSource\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source to activate + + You can set the *iSource*behavior as follows: - **-1** to set all sources activated at 100% power ratio \(equivalent to the *All layers*mode in Virtual Photometric Lab\). - **-2** to activate all sources depending on their current power ratio \(equivalent to the *User defined* mode in Virtual Photometric Lab\). diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetconfigname.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetconfigname.md new file mode 100644 index 0000000000..e1fb19dded --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetconfigname.md @@ -0,0 +1,40 @@ +# ExtendedSetConfigName + +## Description + +Sets the name of the configuration number N. The new name of the configuration must be unique and not empty. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedSetConfigName(int iConfig, BSTR bstrConfigName)` as Boolean +- *object*: Virtual Photometric Lab +- *iConfig*: index of the configuration in Virtual Lighting Controller \(starting from 0\) +- *bstrConfigName*: name of the configuration + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Sets the name of the configuration #3 +XMPViewer.ExtendedSetConfigName(3, "My Configuration") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XmpViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Sets the name of the configuration number 3 +retval = XmpViewer.ExtendedSetConfigName(2, “My Configuration”) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetsourcename.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetsourcename.md new file mode 100644 index 0000000000..8505ff3801 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetsourcename.md @@ -0,0 +1,39 @@ +# ExtendedSetSourceName + +## Description + +Renames one of the sources. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExtendedSetSourceName`\(int iSource, BSTR bstrSourceName\) as Boolean +- *object*: Virtual Photometric Lab object +- *iSource*: index of the source in Virtual Lighting Controller \(starting from 0\) +- *bstrSourceName*: the new name of the source + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Renames source #1 +XMPViewer.ExtendedSetSourceName(1, "Source number one") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Renames the second source +XmpViewer. ExtendedSetSourceName(1, " Source number two") + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetsourceratio.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetsourceratio.md new file mode 100644 index 0000000000..d35f0df716 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_extendedsetsourceratio.md @@ -0,0 +1,22 @@ +# ExtendedSetSourceRatio + +## Description + +Sets the value of one of the sources of an extended or a spectral map \(0 if the map is not an extended or a spectral map\). + +**Note:** + +The *User defined* mode must be active \(*ExtendedSetActiveSource\(-2\)*\) for the power ratio to be effective before using the *ExtendedSetSourceRatio* method. See the [ExtendedSetActiveSource](labvp_extendedsetactivesource.md) chapter for more details. + +## Syntax + +*object*.ExtendedSetSourceRatio\(int iSource, double dRatio\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source + +- *dRatio*: value to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralgetactivewavelength.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralgetactivewavelength.md new file mode 100644 index 0000000000..9df0cba360 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralgetactivewavelength.md @@ -0,0 +1,16 @@ +# SpectralGetActiveWavelength + +## Description + +Gets the active wavelengths of a spectral map. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SpectralGetActiveWavelength\(VARIANT\* ovWavelengthIndex\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovWavelengthIndex*: VARIANT of the index of the active wavelength \(-1 for all\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralgetnbwavelength.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralgetnbwavelength.md new file mode 100644 index 0000000000..8bb9164daa --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralgetnbwavelength.md @@ -0,0 +1,14 @@ +# SpectralGetNbWavelength + +## Description + +Returns the number of wavelength of a spectral map. Returns 0 if the map is not a spectral map. + +## Syntax + +*object*.SpectralGetNbWavelength\(\) As Short + +- *object*: Virtual Photometric Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralsetactivewavelength.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralsetactivewavelength.md new file mode 100644 index 0000000000..ed16d9b5b7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralsetactivewavelength.md @@ -0,0 +1,16 @@ +# SpectralSetActiveWavelength + +## Description + +Sets the active wavelength of a spectral map. Returns 0 if the map is not a spectral map. + +## Syntax + +*object*.SpectralSetActiveWavelength\(int iWavelength\) As Short + +- *object*: Virtual Photometric Lab object + +- *iWavelength*: index of the wavelength to activate \(-1 for all\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralspectrumchange.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralspectrumchange.md new file mode 100644 index 0000000000..472d762681 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_spectralspectrumchange.md @@ -0,0 +1,55 @@ +# SpectralSpectrumChange + +## Description + +Allows you to apply a spectrum to a source on spectral map. + +Returns 0 if: + +- the map is not a spectral map. + +- the index of the source does not exist. + +- the path does not exist or no path defined or wrong path. + + +## Syntax + +*object*.SpectralSpectrumChange\(int *iSource*, BSTR *bstrFileName*\) + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iSource*: index of the source to activate + +- *bstrFileName*: filename string including path + + When bstrFileName does not exist, the spectrum is deactivated on the layer. + + +## Example + +``` +Sub main() + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Dim XmpViewer As Object +Set XmpViewer = CreateObject("XmpViewer.Application") + Dim MyFile As String +MyFile = "NameOfXmpMap.xmp" + retval = XmpViewer.OpenFile(MyFolder & MyFile) + retval = XmpViewer.Show(1) + Dim NbLayer As Integer +NbLayer = XmpViewer.ExtendedGetNbSource() + Dim MySpectrumFile As String +MySpectrumFile = "NameOfSpectrumFile.spectrum" + For i = 0 To NbLayer - 1 +retval = XmpViewer.SpectralSpectrumChange(i, MyFolder & MySpectrumFile) +Next i + For i = 0 To NbLayer - 1 +retval = XmpViewer.SpectralSpectrumChange(i) +Next i + End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_writespectraltable.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_writespectraltable.md new file mode 100644 index 0000000000..72f1e951a6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/extended_and_spectral_map/labvp_writespectraltable.md @@ -0,0 +1,54 @@ +# WriteSpectralTable + +## Description + +This function allows you to create a binary file that includes all the data of a spectral irradiance XMP map. Returns True if the binary file has been generated, False otherwise. + +## Syntax + +*object*.WriteSpectralTable As Boolean + +- *object*: Virtual Photometric Lab + +- Boolean return: returns True if the binary file is generated, False otherwise. + +## Python example + +``` +import numpy as np +import win32com.client # for com with SPEOS API + +filename = R"C:\MySpectralIrradianceMap.xmp" + +error = "" +# open link to XmpViewer API +try: + xmp_viewer = win32com.client.Dispatch("XmpViewer.Application") +except: + error = "Impossible to connect to XmpViewer Application" + +# load data to XmpViewer and check + +if error == "": + if xmp_viewer.OpenFile(filename) != 1: + error = 'Error while opening xmp map: %s' %filename + + else: + if xmp_viewer.WriteSpectralTable == False: + error = 'Error while writing spectral table: %s' %filename + + else: + nb_lambda = xmp_viewer.WNb + yResolution = xmp_viewer.YNb + xResolution = xmp_viewer.XNb + + dataList = np.fromfile(f'{filename.split(".xmp")[0]}.bin', dtype =np.float32) + np.savetxt(f'{filename.split(".xmp")[0]}.txt', dataList) + + data = np.reshape(dataList, (nb_lambda, yResolution, xResolution)) + data = np.flip(data, axis = 1) + + print(data[int(nb_lambda/2)][int(xResolution/2)][int(yResolution/2)]) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filtering.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filtering.md new file mode 100644 index 0000000000..b2832958fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filtering.md @@ -0,0 +1,16 @@ +# Filtering + +## Description + +Applies the XMP filtering on the map data. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.Filtering\(int iNbPasses\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iNbPasses*: filtering level + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filtering_data.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filtering_data.md new file mode 100644 index 0000000000..f7738c4ede --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filtering_data.md @@ -0,0 +1,4 @@ +# Filtering data + +- [Filtering](labvp_filtering.md) +- [FilteringRemoveHighestPeaks](labvp_filteringremovehighestpeaks.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filteringremovehighestpeaks.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filteringremovehighestpeaks.md new file mode 100644 index 0000000000..60cb63a26c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_filteringremovehighestpeaks.md @@ -0,0 +1,18 @@ +# FilteringRemoveHighestPeaks + +## Description + +Applies the XMP filtering and removes highest peaks on the map data. Returns a value different than 0 if no error has occurred. + +## Syntax + +*object*.FilteringRemoveHighestPeaks\(int nNbPasses, double dThreshold\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iNbPasses*: filtering level + +- *dThreshold*: threshold value for removing highest peaks + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_getpid.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_getpid.md new file mode 100644 index 0000000000..dc7a0ab3a5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/filtering_data/labvp_getpid.md @@ -0,0 +1,14 @@ +# GetPID + +## Description + +Returns the process ID of the current instance of the Viewer/Editor. + +## Syntax + +*object*.GetPID\(\) As Long + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_get_value_on_map.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_get_value_on_map.md new file mode 100644 index 0000000000..eb17737352 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_get_value_on_map.md @@ -0,0 +1,16 @@ +# Get value on map + +- [GetColor](labvp_getcolor.md) +- [GetColorSystemColorNames](labvp_getcolorsystemcolornames.md) +- [GetCurrentColorSystem](labvp_getcurrentcolorsystem.md) +- [GetGeneralCRI](labvp_getgeneralcri.md) +- [GetPixelListOnSurface](labvp_getpixellistonsurface.md) +- [GetPrecision](labvp_getprecision.md) +- [GetSelectedLayer](labvp_getselectedlayer.md) +- [GetSelectedLayersUser](labvp_getselectedlayersuser.md) +- [GetValue](labvp_getvalue.md) +- [GetValue1](labvp_getvalue1.md) +- [GetValue2](labvp_getvalue2.md) +- [GetValueEllipse](labvp_getvalueellipse.md) +- [GetValueRectangle](labvp_getvaluerectangl.md) +- [SetMinMax](labvp_setminmax.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcolor.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcolor.md new file mode 100644 index 0000000000..f204ee2a1e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcolor.md @@ -0,0 +1,36 @@ +# GetColor + +## Description + +Returns an array of 3 VARIANT of the colorimetric coordinates at the given position. + +## Syntax + +*object*.GetColor\(double dXPos, double dYPos, short nColorSystem\) As Variant + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *dX*: horizontal coordinate + +- *dY*: vertical coordinate + +- *nColorSystem*: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh + + For 4, 5 and 6, the illuminant defined in the Virtual Photometric Lab is taken into account. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcolorsystemcolornames.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcolorsystemcolornames.md new file mode 100644 index 0000000000..aa7ab9f4fd --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcolorsystemcolornames.md @@ -0,0 +1,30 @@ +# GetColorSystemColorNames + +## Description + +Returns an array of 4 VARIANT representing in order: the name of the color system, the name of each three components of the color system \(for example, U, V, Y if the value returned by [GetCurrentColorSystem](labvp_getcurrentcolorsystem.md) is 2\). + +## Syntax + +*object*.GetColorSystemColorNames\(short iColorSystem\) As Variant + +- *object*: Virtual Photometric Lab object + +- *iColorSystem*: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcurrentcolorsystem.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcurrentcolorsystem.md new file mode 100644 index 0000000000..f88470d09f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getcurrentcolorsystem.md @@ -0,0 +1,30 @@ +# GetCurrentColorSystem + +## Description + +Returns the corresponding color system. + +## Syntax + +*object*.GetCurrentColorSystem\(\) As Short + +- *object*: Virtual Photometric Lab object + +- Returned value: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getgeneralcri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getgeneralcri.md new file mode 100644 index 0000000000..80e0605892 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getgeneralcri.md @@ -0,0 +1,20 @@ +# GetGeneralCRI + +## Description + +Gets the corresponding general color rendering index. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.GetGeneralCRI\(double dX, double dY, VARIANT\* vdCRI\) As Short + +- *object*: Virtual Photometric Lab object + +- *dX*: horizontal coordinate of the point where the general color rendering index has to be calculated + +- *dY*: vertical coordinate of the point where the general color rendering index has to be calculated + +- *vdCRI*: general color rendering index value + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getpixellistonsurface.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getpixellistonsurface.md new file mode 100644 index 0000000000..316b72bd0b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getpixellistonsurface.md @@ -0,0 +1,18 @@ +# GetPixelListOnSurface + +## Description + +Returns an array of Variant of the pixel indexes that are in the current area. + +## Syntax + +*object*.GetPixelListOnSurface\(VARIANT\* vPtX, VARIANT\* vPtY\) As Short + +- *Object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *vPtX*: array of VARIANT for the horizontal indexes of each pixel in the area + +- *vPtY*: array of VARIANT for the vertical indexes of each pixel in the area + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getprecision.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getprecision.md new file mode 100644 index 0000000000..a93d39ae07 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getprecision.md @@ -0,0 +1,16 @@ +# GetPrecision + +## Description + +Returns the map's Precision information \(in percentage\). Returns -1 if the map's Precision value is not known. + +## Syntax + +*object*.GetPrecision\(\) As Double + +- *Object*: Virtual Photometric Lab object + +- Returned value: Precision value in percentage. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getselectedlayer.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getselectedlayer.md new file mode 100644 index 0000000000..2e511ffa08 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getselectedlayer.md @@ -0,0 +1,16 @@ +# GetSelectedLayer + +## Description + +Gets a layer of a multi layer map. Returns 1 if no error has occurred \(map with layers\), 0 otherwise. + +## Syntax + +*object*.GetSelectedLayer\(VARIANT\* ovLayerIndex\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovLayerIndex*: VARIANT of the index of the active layer \(-1 for all, -2 if many\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getselectedlayersuser.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getselectedlayersuser.md new file mode 100644 index 0000000000..cb91405143 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getselectedlayersuser.md @@ -0,0 +1,16 @@ +# GetSelectedLayersUser + +## Description + +Gets selected layers of a multi layer map. Returns a value different than 0 if no error occurred. + +## Syntax + +*object*.GetSelectedLayersUser\(VARIANT\* ovLayerIndexes\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *ovLayerIndex*: an array of VARIANT of the indexes of all active layers + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue.md new file mode 100644 index 0000000000..00023aa6ba --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue.md @@ -0,0 +1,25 @@ +# GetValue + +## Description + +Gets the value at the given position taking into account the active source and the active wavelength if applicable. Returns 0 if the position is outside the map. + +## Syntax + +*object*.GetValue\(double dX, double dY\) As Double. + +- *object*: Virtual Photometric Lab object. + +- *dX*: horizontal coordinate. + +- *dY*: vertical coordinate. + + +## Remark + +- *dX*: Minimum value of the position in mm \(or of the theta angle in radians for conoscopic maps\). + +- *dY*: Maximum value of the position in mm \(or of the theta angle in radians for conoscopic maps\). + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue1.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue1.md new file mode 100644 index 0000000000..0975616c09 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue1.md @@ -0,0 +1,18 @@ +# GetValue1 + +## Description + +Gets the value at the given position. Returns 0 if the position is outside the map. + +## Syntax + +*object*.GetValue1\(double dX, double dY\) As Double + +- *object*: Virtual Photometric Lab object + +- *dX*: horizontal coordinate + +- *dY*: vertical coordinate + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue2.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue2.md new file mode 100644 index 0000000000..ea1f9a4eea --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalue2.md @@ -0,0 +1,20 @@ +# GetValue2 + +## Description + +Gets the value at the given pixel and for the given wavelength index. Returns 0 if the map is not a spectral map. + +## Syntax + +*object*.GetValue2\(double dX, double dY, double dWavelength\) As Double + +- *object*: Virtual Photometric Lab object + +- *dX*: horizontal pixel index + +- *dY*: vertical pixel index + +- *dWaveLength*: wavelength index + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalueellipse.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalueellipse.md new file mode 100644 index 0000000000..e2c92c78e1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvalueellipse.md @@ -0,0 +1,30 @@ +# GetValueEllipse + +## Description + +Gets the average value for the given ellipse area. + +## Syntax + +**Note:** + +The spelling of this function varies between versions. On versions prior to 2019 R2, the function to use is **GetValueElipse**. From 2019 R2 version, the function to use is **GetValueEllipse**. + +*object*.GetValueEllipse\(double dXPos, double dYPos, double dWidth, double dHeight\) As Double + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the ellipse + +- *dYPos*: vertical coordinate of the center of the ellipse + +- *dWidth*: horizontal size of the ellipse + +- *dHeight*: vertical size of the ellipse + + +## Remark + +This function is not available for conoscopic map. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvaluerectangl.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvaluerectangl.md new file mode 100644 index 0000000000..cc0744743a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_getvaluerectangl.md @@ -0,0 +1,35 @@ +# GetValueRectangle + +## Description + +Gets the average value for the given rectangle area. + +## Syntax + +*object*.GetValueRectangle\(double dXPos, double dYPos, double dWidth, double dHeight\) As Double + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + + +## Remark + +For Conoscopic map, the given area is a corona defined by: + +- *dXPos*: Minimum value of the theta angle + +- *dYPos*: Maximum value of the theta angle + +- *dWidth*: Minimum value of the phi angle + +- *dHeight*: Maximum value of the phi angle + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_setminmax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_setminmax.md new file mode 100644 index 0000000000..2d4cc3bbb2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/get_value_on_map/labvp_setminmax.md @@ -0,0 +1,18 @@ +# SetMinMax + +## Description + +Sets the minimum and maximum values of the level. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetMinMax\(double dMin, double dMax\) As Short + +- *object*: Virtual Photometric Lab object + +- *dMin*: minimum + +- *dMax*: maximum + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/labvp_virtual_photometric_lab.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/labvp_virtual_photometric_lab.md new file mode 100644 index 0000000000..9f4f0cf3f0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/labvp_virtual_photometric_lab.md @@ -0,0 +1,60 @@ +# Virtual Photometric Lab + +Automation in Virtual Photometric Lab allows you to access to the data inside XMP maps. + +The installation directory includes: + +- The TLB file that describes the Automation interface of the Virtual Photometric Lab, +- Some HTML example files which have VB script Automation instructions. + +Any language compatible with Automation can be used \(VB, C\#, etc.\). + +## How to call the Virtual Photometric Lab + +Before any call to the Virtual Photometric Lab methods you should use the following instruction: + +``` +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +``` + +This instruction automatically runs the Virtual Photometric Lab \(creates an instance of the application\). The other uses of the Virtual Photometric Lab should refer to the variable *VirtualPhotometricLab* which has been initialized with this instance. + +You could notice that there is no reference to the path where the Virtual Photometric Lab is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *XmpViewer.Application*. + +## How to call a method + +VB Script Language + +To call a method, write *VirtualPhotometricLab* followed by a **.** then by the name of the method and parameters \(strings between **"** and **"**\), each separated by **,**. For example for opening an XMP map, write the following instructions: + +``` +Dim MyVar MyVar = VirtualPhotometricLab.OpenFile("MyMap.xmp") +``` + +The *OpenFile* method takes a string as parameter. The variable MyVar holds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the Virtual Photometric Lab. + +C\# Language + +In Framework .NET 4.5, add the TLB reference « XMPViewer.tlb » to the project. + +Add this command: using XmpViewer. + +Then, the commands can be used as follows: + +``` +XmpViewer.Application testmap = new XmpViewer.Application(); testmap.OpenFile("d:\\filename.xmp"); testmap.Show(1); +``` + +## Syntax description + +All the available methods will be described below using the following syntax: + +object.Method\_Name \(parameter 1, parameter 2, etc.\) as return\_type + +With: + +- Method\_Name: name of the method. +- Parameter n: a keyword for the type of the parameter followed by the parameter name. +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string, etc.\). \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_automaticupdate.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_automaticupdate.md new file mode 100644 index 0000000000..50a5d31e20 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_automaticupdate.md @@ -0,0 +1,16 @@ +# AutomaticUpdate + +## Description + +Modifies the automatic update flag and returns 1. + +## Syntax + +*object*.AutomaticUpdate\(short bAutomaticUpdate\) As Short + +- *object*: Virtual Photometric Lab object + +- *bAutomaticUpdate*: automatic update flag + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_axissymetry.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_axissymetry.md new file mode 100644 index 0000000000..70689a19ca --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_axissymetry.md @@ -0,0 +1,16 @@ +# AxisSymetry + +## Description + +Makes a symmetry axis of the map. + +## Syntax + +*object*.AxisSymetry\(short nMode\) As Short + +- *object*: Virtual Photometric Lab object + +- *nMode*: axis, 0 for vertical axis, 1 for horizontal axis. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_caption.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_caption.md new file mode 100644 index 0000000000..e61adc0401 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_caption.md @@ -0,0 +1,14 @@ +# Caption + +## Description + +Returns the caption title of the viewer/editor. + +## Syntax + +*object*.Caption\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_fillbackground.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_fillbackground.md new file mode 100644 index 0000000000..93fb8cdea6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_fillbackground.md @@ -0,0 +1,16 @@ +# FillBackground + +## Description + +Fills the background of the Virtual Photometric Lab viewer with white to analyze isocurves and returns 1. + +## Syntax + +*object*.FillBackground\(short bState\) As Short + +- *object*: Virtual Photometric Lab object + +- *bState*: 0 to keep the background unchanged, 1 to fill the background with white. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_getcomment.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_getcomment.md new file mode 100644 index 0000000000..a980390885 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_getcomment.md @@ -0,0 +1,11 @@ +# GetComment + +## Description + +Not supported. + +## Syntax + +*object*.GetComment\(\) As Short + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_gethorizontalflip.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_gethorizontalflip.md new file mode 100644 index 0000000000..625a417253 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_gethorizontalflip.md @@ -0,0 +1,50 @@ +# GetHorizontalFlip + +## Description + +Gives the horizontal flip status of a map. + +Returns TRUE if the map is horizontally flipped, FALSE otherwise. + +## Syntax + +*object.GetHorizontalFlip* + +- *object*: XMPViewer object + + +## VB script example + +```VB +Sub HorizontalFlip () +'Error Management +Dim Error As Integer +'Declares XMPViewer +Dim Viewer As Object +Set Viewer = CreateObject("XmpViewer.Application ") +'Shows XMPViewer +Viewer.Show(1) +'Opens File +Error = Viewer.OpenFile("C:\temp\Spectral.xmp ") +' Gets horizontal flip status +Dim RetVal +RetVal = Viewer.GetHorizontalFlip +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +# Gets horizontal flip status +retval = XMPViewer.GetHorizontalFlip() + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_horizontalflip.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_horizontalflip.md new file mode 100644 index 0000000000..9d49e6d55c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_horizontalflip.md @@ -0,0 +1,47 @@ +# HorizontalFlip + +## Description + +Flips horizontally the map. + +Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.HorizontalFlip\(\) As Short + +- *object*: Virtual Photometric Lab + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab1 = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab1.Show(True) +Error = VirtualPhotometricLab1.OpenFile("C:\TailLamp.xmp") +Set VirtualPhotometricLab2 = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab2.Show(True) +Error = VirtualPhotometricLab2.OpenFile("C:\TailLamp.xmp") +' Flip the map horizontally +Error = VirtualPhotometricLab2.HorizontalFlip +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +# Flip the map horizontally +XMPViewer.HorizontalFlip() + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_isocurves.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_isocurves.md new file mode 100644 index 0000000000..e7b29ae640 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_isocurves.md @@ -0,0 +1,16 @@ +# IsoCurves + +## Description + +Displays or hides ISO curves and returns 1. + +## Syntax + +*object*.IsoCurves\(short bState\) As Short + +- *object*: Virtual Photometric Lab object + +- *bState*: 0 to hide, 1 to display iso curves + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_loadscalelevels.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_loadscalelevels.md new file mode 100644 index 0000000000..270c0b285b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_loadscalelevels.md @@ -0,0 +1,16 @@ +# LoadScaleLevels + +## Description + +Load scale Levels. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.LoadScaleLevels\(LPCSTR strFileName\) As Short + +- *object*: Virtual Photometric Lab object + +- *strFileName*: scale file name + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_map_and_display_option.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_map_and_display_option.md new file mode 100644 index 0000000000..ed4b9c4723 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_map_and_display_option.md @@ -0,0 +1,27 @@ +# Map and display option + +- [AutomaticUpdate](labvp_automaticupdate.md) +- [AxisSymetry](labvp_axissymetry.md) +- [Caption](labvp_caption.md) +- [FillBackground](labvp_fillbackground.md) +- [GetComment](labvp_getcomment.md) +- [HorizontalFlip](labvp_horizontalflip.md) +- [GetHorizontalFlip](labvp_gethorizontalflip.md) +- [IsoCurves](labvp_isocurves.md) +- [LoadScaleLevels](labvp_loadscalelevels.md) +- [NightVisionGoggles](labvp_nightvisiongoggles.md) +- [SaveScaleImage](labvp_savescaleimage.md) +- [SetAlwaysOnTop](labvp_setalwaysontop.md) +- [SetAutomaticGrid](labvp_setautomaticgrid.md) +- [SetComment](labvp_setcomment.md) +- [SetDisplayMode](labvp_setdisplaymode.md) +- [SetGridOrigin](labvp_setgridorigin.md) +- [SetPrimaryGridSteps](labvp_setprimarygridsteps.md) +- [SetSecondaryGraduationNbs](labvp_setsecondarygraduationnbs.md) +- [Show](labvp_show.md) +- [ShowPrimaryGrid](labvp_showprimarygrid.md) +- [ShowSecondaryGrid](labvp_showsecondarygrid.md) +- [ShowRuler](labvp_showruler.md) +- [SpectralFiltering](labvp_spectralfiltering.md) +- [UpdateDisplayAndData](labvp_updatedisplayanddata.md) +- [SetLogScale](labvp_setlogscale.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_nightvisiongoggles.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_nightvisiongoggles.md new file mode 100644 index 0000000000..7686683f0e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_nightvisiongoggles.md @@ -0,0 +1,16 @@ +# NightVisionGoggles + +## Description + +Activates or deactivates night vision goggle data contained in **.nvg** files. Night vision goggle data can be generated using the editor inside Virtual Photometric Lab/Virtual Human Vision Lab. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.NightVisionGoggles\(BSTR strNVGFileName\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *strNVGFileName*: Name of the **.nvg** file containing night vision goggle data. To deactivate the filter, enter a void string. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_savescaleimage.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_savescaleimage.md new file mode 100644 index 0000000000..e0848ddc25 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_savescaleimage.md @@ -0,0 +1,22 @@ +# SaveScaleImage + +## Description + +Return value: Save Scale Image and return true if the call succeeds, false otherwise. + +## Syntax + +*object*.SaveScaleImage\(LPCSTR strFileName, int iImageFileFormat, int iWidth, int iHeight \) As Boolean + +- *object*: Virtual Photometric Lab object + +- *strFileName*: file name to save the image + +- *iImageFileFormat*: image format \(0: bmp, 3: jpg\) + +- *iWidth*: horizontal number of pixel + +- *iHeight*: vertical number of pixel + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setalwaysontop.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setalwaysontop.md new file mode 100644 index 0000000000..5c22c970f4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setalwaysontop.md @@ -0,0 +1,16 @@ +# SetAlwaysOnTop + +## Description + +Sets the window of the Virtual Photometric Lab on top \(or use the normal behavior\). Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.SetAlwaysOnTop\(short bAlwaysOnTop\) As Short + +- *object*: Virtual Photometric Lab object + +- *bAlwaysOnTop*: A value different than 0 to set the window always on top + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setautomaticgrid.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setautomaticgrid.md new file mode 100644 index 0000000000..60f4c35840 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setautomaticgrid.md @@ -0,0 +1,51 @@ +# SetAutomaticGrid + +## Description + +Set the mode of definition for the grid. The grid can be defined automatically \(**True**\) or user-defined \(**False**\) + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetAutomaticGrid\(bAutomaticGrid As Integer\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *bAutomaticGrid*: boolean being **True** \(automatic mode\) or **False** \(user-defined mode\) + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetPrimaryGridSteps(5, 10) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) 'Activate the user-defined grid +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +XMPViewer.ShowPrimaryGrid(True) +XMPViewer.ShowRuler(True) +XMPViewer.SetPrimaryGridSteps(5, 10) +XMPViewer.SetAutomaticGrid(False) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setcomment.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setcomment.md new file mode 100644 index 0000000000..2e0e3c1e26 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setcomment.md @@ -0,0 +1,16 @@ +# SetComment + +## Description + +Sets the text comment of the map and returns 0. + +## Syntax + +*object*.SetComment\(BSTR bstrComment\) As Short + +- *object*: Virtual Photometric Lab object + +- *bstrComment*: Text comment to set + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setdisplaymode.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setdisplaymode.md new file mode 100644 index 0000000000..a9e80caf92 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setdisplaymode.md @@ -0,0 +1,16 @@ +# SetDisplayMode + +## Description + +Sets the display mode. + +## Syntax + +*object*.SetDisplayMode\(short nMode\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *nMode*: display mode \(0 for standard, 1 for full screen, 2 for full screen and stretched image\) + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setgridorigin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setgridorigin.md new file mode 100644 index 0000000000..7d25a0e201 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setgridorigin.md @@ -0,0 +1,36 @@ +# SetGridOrigin + +## Description + +Set the position of the grid origin. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetGridOrigin\(*dOriginX*As Double, *dOriginY*As Double\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *dOriginX:*horizontal position of the grid origin + +- *dOriginY:*vertical position of the grid origin + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetGridOrigin(2, 3) 'Origin is user-defined (XOrigin=2mm; YOrigin=3mm) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setlogscale.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setlogscale.md new file mode 100644 index 0000000000..99a4aa1889 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setlogscale.md @@ -0,0 +1,16 @@ +# SetLogScale + +## Description + +Activates the linear scale or the logarithmic one. + +## Syntax + +*object*.SetLogScale\(bool bScale\) As Short + +- *object*: Virtual Photometric Lab + +- *bScale*: True to activate the Logarithmic scale, false to activate the Linear scale + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setprimarygridsteps.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setprimarygridsteps.md new file mode 100644 index 0000000000..d7dc2f2ae0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setprimarygridsteps.md @@ -0,0 +1,53 @@ +# SetPrimaryGridSteps + +## Description + +Set the steps of the primary grid. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetPrimaryGridSteps\(*dStepX*As Double, *dStepY*As Double\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *dStepX:*horizontal step of the primary grid + +- *dStepY:*vertical step of the primary grid + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetPrimaryGridSteps(5, 10) 'Grid steps of the primary grid are user-defined (XPrimaryStep=5mm; YPrimaryStep=10mm) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +XMPViewer.ShowPrimaryGrid(True) +XMPViewer.ShowRuler(True) +XMPViewer.SetPrimaryGridSteps(5, 10) +XMPViewer.SetAutomaticGrid(False) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setsecondarygraduationnbs.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setsecondarygraduationnbs.md new file mode 100644 index 0000000000..ff20ef44d0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_setsecondarygraduationnbs.md @@ -0,0 +1,37 @@ +# SetSecondaryGraduationNbs + +## Description + +Set the number of graduations of the secondary grid. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetSecondaryGraduationNbs\(*iGradNbX*As Long, *iGradNbY*As Long\) As Integer + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *iGradNbX:*horizontal number of graduations for the secondary grid + +- *iGradNbY:*vertical number of graduations for the secondary grid + + +## Example + +``` +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLampVE.xmp") +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +Error = VirtualPhotometricLab.ShowRuler(True) +Error = VirtualPhotometricLab.SetAutomaticGrid(False) +Error = VirtualPhotometricLab.SetSecondaryGraduationNbs(10, 10) 'Graduation number of the secondary grid is user-defined (XSecondaryGraduationNb=5mm; YSecondaryGraduationNb=10mm) +Error = VirtualPhotometricLab.ShowSecondaryGrid(True) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_show.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_show.md new file mode 100644 index 0000000000..416b4c16fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_show.md @@ -0,0 +1,16 @@ +# Show + +## Description + +Displays or hides the window of the Viewer/Editor and returns a value different than 0. + +## Syntax + +*object*.Show\(short bShow\) As Short + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab, Virtual Human Vision Lab or Ray File Editor object + +- *bShow*: 0 for hide, else 1 + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showprimarygrid.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showprimarygrid.md new file mode 100644 index 0000000000..9dd27b6c9a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showprimarygrid.md @@ -0,0 +1,49 @@ +# ShowPrimaryGrid + +## Description + +Shows the primary grid inside the viewer. + +Returns -1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.ShowPrimaryGrid\(short *bShowPrimaryGrid*\) As Short + +- *object*: Virtual Photometric Lab + +- *bShowPrimaryGrid*: boolean being **True** to show or **False** else + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLamp.xmp") +'Show the primary grid +Error = VirtualPhotometricLab.ShowPrimaryGrid(True) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +XMPViewer.ShowPrimaryGrid(True) +XMPViewer.ShowRuler(True) +XMPViewer.SetPrimaryGridSteps(5, 10) +XMPViewer.SetAutomaticGrid(False) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showruler.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showruler.md new file mode 100644 index 0000000000..345b778652 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showruler.md @@ -0,0 +1,53 @@ +# ShowRuler + +**Note:** + +The **Showruler** API is deactivated for theta/phi maps. + +## Description + +Shows the rulers inside the viewer. + +Returns a value different from 0 if no error occurred. + +## Syntax + +*object*.ShowRuler\(short *bShowRuler*\) As Short + +- *object*: Virtual Photometric Lab + +- *bShowRuler*: boolean being **True** to show or **False** else + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show (True) +Error = VirtualPhotometricLab.OpenFile ("C:\TailLamp.xmp") +'Show the rulers +Error = VirtualPhotometricLab.ShowRuler (True) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +XMPViewer.ShowPrimaryGrid(True) +XMPViewer.ShowRuler(True) +XMPViewer.SetPrimaryGridSteps(5, 10) +XMPViewer.SetAutomaticGrid(False) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showsecondarygrid.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showsecondarygrid.md new file mode 100644 index 0000000000..61d99051dd --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_showsecondarygrid.md @@ -0,0 +1,47 @@ +# ShowSecondaryGrid + +## Description + +Shows the secondary grid inside the viewer. + +Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.ShowSecondaryGrid\(short *bShowSecondaryGrid*\) As Short + +- *object*: Virtual Photometric Lab + +- *bShowSecondaryGrid*: boolean being **True** to show or **False** else + + +## VB script example + +```VB +Sub main() +Dim Error As Integer +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +Error = VirtualPhotometricLab.Show(True) +Error = VirtualPhotometricLab.OpenFile("C:\TailLamp.xmp") +'Show the secondary grid +Error = VirtualPhotometricLab.ShowSecondaryGrid(True) +End Sub + +``` + +## IronPython example + +```ironpython +from System import Type, Activator +type = Type.GetTypeFromProgID("XMPViewer.Application") +XMPViewer = Activator.CreateInstance(type) +# Opens a file +MyFile = ("C:\\tmp\\XMPViewer\\Exemple.xmp") +XMPViewer.OpenFile(MyFile) +XMPViewer.Show(1) +# Show the secondary grid +XMPViewer. ShowSecondaryGrid(True) + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_spectralfiltering.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_spectralfiltering.md new file mode 100644 index 0000000000..2e97015c4a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_spectralfiltering.md @@ -0,0 +1,16 @@ +# SpectralFiltering + +## Description + +Activates or deactivates color filter spectrum or sun glasses spectrum. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SpectralFiltering\(BSTR strSpectralFilterFileName\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *strSpectralFilterFileName*: path to the spectrum name. To deactivate the filter, enter a void string. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_updatedisplayanddata.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_updatedisplayanddata.md new file mode 100644 index 0000000000..78fa9b0fc2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_and_display_option/labvp_updatedisplayanddata.md @@ -0,0 +1,16 @@ +# UpdateDisplayAndData + +## Description + +Update all the display and the data of the Viewer. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.UpdateDisplayAndData\(\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + +Some methods modify the display options \(for example ExtendedSetActiveConfig\). In order for the display to take these changes into account, calling the UpdateDisplayAndData method may be necessary. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_filename.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_filename.md new file mode 100644 index 0000000000..ce79c18934 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_filename.md @@ -0,0 +1,14 @@ +# Filename + +## Description + +Gets the file name of a file. + +## Syntax + +*object*.FileName\(\) As String + +- *object*: Eulumdat Viewer, IES Viewer, User Material Editor, Virtual Photometric Lab or Virtual Human Vision Lab object + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_map_information.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_map_information.md new file mode 100644 index 0000000000..c58eb35446 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_map_information.md @@ -0,0 +1,19 @@ +# Map information + +- [Filename](labvp_filename.md) +- [Position](labvp_position.md) +- [WMax](labvp_wmax.md) +- [WMin](labvp_wmin.md) +- [WNb](labvp_wnb.md) +- [WSampleWidth](labvp_wsamplewidth.md) +- [XMax](labvp_xmax.md) +- [XMin](labvp_xmin.md) +- [XNb](labvp_xnb.md) +- [XWidth](labvp_xwidth.md) +- [XSampleWidth](labvp_xsamplewidth.md) +- [XYZToBlackbodyTemperature](labvp_xyztoblackbodytemperature.md) +- [YMax](labvp_ymax.md) +- [Ymin](labvp_ymin.md) +- [YNb](labvp_ynb.md) +- [YHeight ](labvp_yheight.md) +- [YSampleHeight](labvp_ysampleheight.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_position.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_position.md new file mode 100644 index 0000000000..dc1fc051fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_position.md @@ -0,0 +1,16 @@ +# Position + +## Description + +Sets the position in a Virtual Photometric Lab/Virtual Human Vision Lab window. Returns 0 if no error has occurred, 1 otherwise 1. + +## Syntax + +*object*.Position\(short nXPos, short nYPos\) As Short + +- *object*: Virtual Photometric Lab or Virtual Human Vision Lab object + +- *nXPos, nYPos*: new position of the window. + + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wmax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wmax.md new file mode 100644 index 0000000000..a98eec135a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wmax.md @@ -0,0 +1,13 @@ +# WMax + +## Description + +Gets the maximal wavelength of the map \(0 if the map is not a spectral map\). + +## Syntax + +*object*.WMax\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wmin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wmin.md new file mode 100644 index 0000000000..a8e2240aca --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wmin.md @@ -0,0 +1,13 @@ +# WMin + +## Description + +Gets the minimal wavelength of the map \(0 if the map is not a spectral map\). + +## Syntax + +*object*.WMin\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wnb.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wnb.md new file mode 100644 index 0000000000..57758fe702 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wnb.md @@ -0,0 +1,13 @@ +# WNb + +## Description + +Gets the number of wavelengths of the map \(0 if the map is not a spectral map\). + +## Syntax + +*object*.WNb\(\) As Short + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wsamplewidth.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wsamplewidth.md new file mode 100644 index 0000000000..f02d2a61e0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_wsamplewidth.md @@ -0,0 +1,13 @@ +# WSampleWidth + +## Description + +Gets the size of the wavelength sampling \(0 if the map is not a spectral map\). + +## Syntax + +*object*.WSampleWidth\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xmax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xmax.md new file mode 100644 index 0000000000..00fa55f01e --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xmax.md @@ -0,0 +1,13 @@ +# XMax + +## Description + +Gets the horizontal coordinate of the map right edge. + +## Syntax + +*object*.XMax\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xmin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xmin.md new file mode 100644 index 0000000000..34f99a8cbd --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xmin.md @@ -0,0 +1,13 @@ +# XMin + +## Description + +Gets the horizontal coordinate of the map left edge. + +## Syntax + +*object*.XMin\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xnb.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xnb.md new file mode 100644 index 0000000000..754dc061fa --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xnb.md @@ -0,0 +1,13 @@ +# XNb + +## Description + +Gets the number of pixels along the horizontal axis. + +## Syntax + +*object*.XNb\(\) As Short + +*object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xsamplewidth.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xsamplewidth.md new file mode 100644 index 0000000000..ccee378707 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xsamplewidth.md @@ -0,0 +1,13 @@ +# XSampleWidth + +## Description + +Gets the horizontal width of each pixel of the map. + +## Syntax + +*object*.XSampleWidth\(\) As Short + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xwidth.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xwidth.md new file mode 100644 index 0000000000..7d44bc275f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xwidth.md @@ -0,0 +1,13 @@ +# XWidth + +## Description + +Gets the horizontal width of the map. + +## Syntax + +*object*.XWidth\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xyztoblackbodytemperature.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xyztoblackbodytemperature.md new file mode 100644 index 0000000000..0521fc9806 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_xyztoblackbodytemperature.md @@ -0,0 +1,32 @@ +# XYZToBlackbodyTemperature + +## Description + +Gets the blackbody temperature corresponding to the XYZ colorimetric coordinates. + +Returns 1 if no error has occurred, -1 if the input data are not valid and 0 if it is impossible to calculate a temperature with the given input data. + +## Syntax + +*object*.XYZToBlackbodyTemperature\(VARIANT\* vXYZ, VARIANT\* vTemperature\) As Short + +*object*: Virtual Photometric Lab object + +- vXYZ: an array of 3 VARIANT of the XYZ colorimetric values + +- vTemparature: the output data, the blackbody temperature, as a double ; If vTemperature is -1.0 so the calculation failed + + +## Example + +Dim ColorXYZ, Temperature + +ColorXYZ= XMPViewer.SurfaceRectangleColor\(0, 0, 200, 200, 0\) + +MyVar= XMPViewer.XYZToBlackbodyTemperature\(ColorXYZ, Temperature\) + +**Note:** + +The last parameter of SurfaceRectangleColor\(\) must be 0 if you want to use ColorXYZ result to calculate a color temperature. + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_yheight.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_yheight.md new file mode 100644 index 0000000000..40906c9824 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_yheight.md @@ -0,0 +1,13 @@ +# YHeight + +## Description + +Gets the vertical height of the map. + +## Syntax + +*object*.YHeight\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ymax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ymax.md new file mode 100644 index 0000000000..21c6568de4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ymax.md @@ -0,0 +1,13 @@ +# YMax + +## Description + +Gets the vertical coordinate of the top edge of the map. + +## Syntax + +*object*.YMax\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ymin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ymin.md new file mode 100644 index 0000000000..9370532b27 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ymin.md @@ -0,0 +1,13 @@ +# Ymin + +## Description + +Gets the vertical coordinate of the bottom edge of the map. + +## Syntax + +*object*.YMin\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ynb.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ynb.md new file mode 100644 index 0000000000..8dc373117a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ynb.md @@ -0,0 +1,13 @@ +# YNb + +## Description + +Gets the number of pixels along the vertical axis. + +## Syntax + +*object*.YNb\(\) As Short + +*object*: Virtual Photometric Lab or Virtual Human Vision Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ysampleheight.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ysampleheight.md new file mode 100644 index 0000000000..cb8b07c99b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/map_information/labvp_ysampleheight.md @@ -0,0 +1,13 @@ +# YSampleHeight + +## Description + +Gets the vertical height of each pixel of the map. + +## Syntax + +*object*.YSampleHeight\(\) As Double + +*object*: Virtual Photometric Lab object + + diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_getmagnitude.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_getmagnitude.md new file mode 100644 index 0000000000..0c14379dfe --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_getmagnitude.md @@ -0,0 +1,54 @@ +# GetMagnitude + +## Description + +Gets the current measure magnitude. + +## Syntax + +- `object.GetMagnitude()` as Short +- *object*: Virtual Photometric Lab +- *returned value*: + - 0: Default magnitude of the map + - 1: x color component, xyY color space + - 2: y color component, xyY color space + - 3: u color component, uvY color space + - 4: v color component, uvY color space + - 5: u' color component, u'v'Y color space + - 6: v' color component, u'v'Y color space + - 7: u\* color component, L\*u\*v\* color space + - 8: v\* color component, L\*u\*v\* color space + - 9: a\* color component, L\*a\*b\* color space + - 10: b\* color component, L\*a\*b\* color space + - 11: C\* color component, L\*C\*h color space + - 12: h color component, L\*C\*h color space + - 13: X color component, XYZ color space + - 14: Y color component, XYZ color space + - 15: Z color component, XYZ color space + - 16: L\* color component, L\*u\*v\* color space + - 17: Dimension + - 18: Glare + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Gets the current magnitude +result = XMPViewer.GetMagnitude() +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Gets the current magnitude +Retval = XMPViewer.GetMagnitude() +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_measuresexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_measuresexporttxt.md new file mode 100644 index 0000000000..d601382d41 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_measuresexporttxt.md @@ -0,0 +1,35 @@ +# MeasuresExportTXT + +## Description + +Exports the areas, measures and rules defined in the measures tool to a text file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.MeasuresExportTXT(BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *bstrFileName*: path and filename of the text \(.txt\) file + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports into TXT file +XMPViewer.MeasuresExportTXT("C:\Example.TXT") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports into TXT file +XmpViewer. MeasuresExportTXT ("C:\\Example.txt ") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_removesurfacethresholdmax.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_removesurfacethresholdmax.md new file mode 100644 index 0000000000..6e721b1300 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_removesurfacethresholdmax.md @@ -0,0 +1,11 @@ +# RemoveSurfaceThresholdMax + +## Description + +Removes the applied maximum threshold value for surface calculations. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.RemoveSurfaceThresholdMax\(\) As Short + +- *object*: Virtual Photometric Lab object diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_removesurfacethresholdmin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_removesurfacethresholdmin.md new file mode 100644 index 0000000000..9cd00b156b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_removesurfacethresholdmin.md @@ -0,0 +1,11 @@ +# RemoveSurfaceThresholdMin + +## Description + +Removes the applied minimum threshold value for surface calculations. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.RemoveSurfaceThresholdMin\(\) As Short + +- *object*: Virtual Photometric Lab object diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setmagnitude.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setmagnitude.md new file mode 100644 index 0000000000..17280135c4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setmagnitude.md @@ -0,0 +1,37 @@ +# SetMagnitude + +## Description + +Sets the current measure magnitude. Returns TRUE if the call has succeeded, FALSE otherwise. + +Caution: the current measure magnitude is reset to the default magnitude of the map during the execution of the OpenFile, AsyncOpenFile, ImportTXT and CreateMap methods. + +## Syntax + +- `object.SetMagnitude(short iMagnitude)` as Boolean +- *object*: Virtual Photometric Lab +- *iMagnitude*: index of the magnitude + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Sets the magnitude to X color component, XYZ color space +XMPViewer.SetMagnitude(13) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Sets the magnitude to X color component, XYZ color space +XMPViewer.SetMagnitude(13) +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setsurfacethresholdma.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setsurfacethresholdma.md new file mode 100644 index 0000000000..5a6949c1e3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setsurfacethresholdma.md @@ -0,0 +1,13 @@ +# SetSurfaceThresholdMax + +Description + +Sets and applies a maximum threshold value for surface calculations. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetSurfaceThresholdMax\(double dValue\) As Short + +- *object*: Virtual Photometric Lab object + +- *dValue*: threshold value diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setsurfacethresholdmin.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setsurfacethresholdmin.md new file mode 100644 index 0000000000..29be9ab055 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_setsurfacethresholdmin.md @@ -0,0 +1,13 @@ +# SetSurfaceThresholdMin + +## Description + +Sets and applies a minimum threshold value for surface calculations. Returns 1 if no error has occurred, 0 otherwise. + +## Syntax + +*object*.SetSurfaceThresholdMin\(double dValue\) As Short + +- *object*: Virtual Photometric Lab object + +- *dValue*: threshold value diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surface_calculation_on_map.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surface_calculation_on_map.md new file mode 100644 index 0000000000..550b4c7507 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surface_calculation_on_map.md @@ -0,0 +1,37 @@ +# Surface calculation on map + +- [SurfaceEllipseBarycentre](labvp_surfaceellipsebarycentre.md) +- [SurfaceEllipseCalculation](labvp_surfaceellipsecalculation.md) +- [SurfaceEllipseColor](labvp_surfaceellipsecolor.md) +- [SurfaceEllipseExport](labvp_surfaceellipseexport.md) +- [SurfaceEllipseGeneralCRI](labvp_surfaceellipsegeneralcri.md) +- [SurfaceEllipseSigma](labvp_surfaceellipsesigma.md) +- [SurfaceEllipseExportSpectrum](labvp_surfaceellipseexportspectrum.md) +- [SurfaceLineCalculation](labvp_surfacelinecalculation.md) +- [SurfaceLineCalculation2](labvp_surfacelinecalculation2.md) +- [SurfaceLineExportTXT](labvp_surfacelineexporttxt.md) +- [SurfaceLineExportSpectrum](labvp_surfacelineexportspectrum.md) +- [SurfacePolylineExportTXT](labvp_surfacepolylineexporttxt.md) +- [SurfacePolylineExportSpectrum](labvp_surfacepolylineexportspectrum.md) +- [SurfacePolygonBarycentre](labvp_surfacepolygonbarycentre.md) +- [SurfacePolygonCalculation](labvp_surfacepolygoncalculation.md) +- [SurfacePolygonColor](labvp_surfacepolygoncolor.md) +- [SurfacePolygonExport](labvp_surfacepolygonexport.md) +- [SurfacePolygonGeneralCRI](labvp_surfacepolygongeneralcri.md) +- [SurfacePolygonSigma](labvp_surfacepolygonsigma.md) +- [SurfacePolygonExportSpectrum](labvp_surfacepolygonexportspectrum.md) +- [SurfacePointExportSpectrum](labvp_surfacepointexportspectrum.md) +- [SurfaceRectangleBarycentre](labvp_surfacerectanglebarycentre.md) +- [SurfaceRectangleCalculation](labvp_surfacerectanglecalculation.md) +- [SurfaceRectangleColor](labvp_surfacerectanglecolor.md) +- [SurfaceRectangleExport](labvp_surfacerectangleexport.md) +- [SurfaceRectangleGeneralCRI](labvp_surfacerectanglegeneralcri.md) +- [SurfaceRectangleSigma](labvp_surfacerectanglesigma.md) +- [SurfaceRectangleExportSpectrum](labvp_surfacerectangleexportspectrum.md) +- [SetSurfaceThresholdMax](labvp_setsurfacethresholdma.md) +- [SetSurfaceThresholdMin](labvp_setsurfacethresholdmin.md) +- [RemoveSurfaceThresholdMax](labvp_removesurfacethresholdmax.md) +- [RemoveSurfaceThresholdMin](labvp_removesurfacethresholdmin.md) +- [GetMagnitude](labvp_getmagnitude.md) +- [SetMagnitude](labvp_setmagnitude.md) +- [MeasuresExportTXT](labvp_measuresexporttxt.md) diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsebarycentre.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsebarycentre.md new file mode 100644 index 0000000000..2b09336425 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsebarycentre.md @@ -0,0 +1,23 @@ +# SurfaceEllipseBarycentre + +## Description + +Return value: returns an array of 2 VARIANT representing of the barycentre x and y values for the given ellipse area. + +## Syntax + +*object*.SurfaceEllipseBarycentre\(double dXPos, double dYPos, double dWidth, double dHeight\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the ellipse + +- *dYPos*: vertical coordinate of the center of the ellipse + +- *dWidth*: horizontal size of the ellipse + +- *dHeight*: vertical size of the ellipse + +## Remark + +This function is not available for conoscopic map. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsecalculation.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsecalculation.md new file mode 100644 index 0000000000..f8e12004b3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsecalculation.md @@ -0,0 +1,55 @@ +# SurfaceEllipseCalculation + +## Description + +Returns an array of 16 VARIANT of the values for the given ellipse area in the following order: + +1. Minimum value + +2. Minimum value X coordinate + +3. Minimum value Y coordinate + +4. Maximum value + +5. Maximum value X coordinate + +6. Maximum value Y coordinate + +7. Flux \(in case of Irradiance or Intensity map\) or Integral \(in case of Radiance map\) + +8. Average + +9. Contrast + +10. Sigma + +11. Barycenter X coordinate + +12. Barycenter Y coordinate + +13. Sigma X coordinate + +14. Sigma Y coordinate + +15. RMS Contrast + +16. Eye Irradiance + +## Syntax + +*object*.SurfaceEllipseCalculation\(double dXPos, double dYPos, double dWidth, double dHeight\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the ellipse + +- *dYPos*: vertical coordinate of the center of the ellipse + +- *dWidth*: horizontal size of the ellipse + +- *dHeight*: vertical size of the ellipse + +## Remark + +This function is not available for conoscopic map. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsecolor.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsecolor.md new file mode 100644 index 0000000000..87ab40f073 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsecolor.md @@ -0,0 +1,35 @@ +# SurfaceEllipseColor + +## Description + +Returns an array of 3 VARIANT representing the three components of the average color for the given ellipse area and a given color system. + +## Syntax + +*object*.SurfaceEllipseColor\(double dXPos, double dYPos, double dWidth, double dHeight, short iColorSystem\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the ellipse + +- *dYPos*: vertical coordinate of the center of the ellipse + +- *dWidth*: horizontal size of the ellipse + +- *dHeight*: vertical size of the ellipse + +- *iColorSystem*: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipseexport.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipseexport.md new file mode 100644 index 0000000000..f70bd147c4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipseexport.md @@ -0,0 +1,23 @@ +# SurfaceEllipseExport + +## Description + +Exports a XMP map or a text file of the selected ellipsoidal surface. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.SurfaceRectangleExport \(double dXPos, double dYPos, double dWidth, double dHeight, string bstrFileName, integer iFormat\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +- *bstrFileName*: path and filename of the output file. Should end by **.xmp** for XMP map or **.txt** for a text file. + +- *iFormat*: format of the output file, 0 for text file, 1 for XMP map. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipseexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipseexportspectrum.md new file mode 100644 index 0000000000..fd1553000b --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipseexportspectrum.md @@ -0,0 +1,39 @@ +# SurfaceEllipseExportSpectrum + +## Description + +Exports the spectrum data of a measurement ellipse to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceEllipseExportSpectrum(double dXPos, double dYPos, double dWidth, double dHeight, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *dXPos*: horizontal coordinate of the center of the ellipse +- *dYPos*: vertical coordinate of the center of the ellipse +- *dWidth*: horizontal size of the ellipse +- *dHeight*: vertical size of the ellipse +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file. + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +XMPViewer.SurfaceEllipseExportSpectrum(0, 0, 0.25, 0.25, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +XMPViewer.SurfaceEllipseExportSpectrum(0, 0, 0.25, 0.25, "C:\\Example.spe") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsegeneralcri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsegeneralcri.md new file mode 100644 index 0000000000..a6d89e6907 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsegeneralcri.md @@ -0,0 +1,21 @@ +# SurfaceEllipseGeneralCRI + +## Description + +Returns the general color rendering index for the given ellipse area. + +## Syntax + +*object*.SurfaceEllipseGeneralCRI\(double dXPos, double dYPos, double dWidth, double dHeight, VARIANT\* vdCRI\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the ellipse + +- *dYPos*: vertical coordinate of the center of the ellipse + +- *dWidth*: horizontal size of the ellipse + +- *dHeight*: vertical size of the ellipse + +- *vdCRI*: general color rendering index value diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsesigma.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsesigma.md new file mode 100644 index 0000000000..c5d8f35334 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfaceellipsesigma.md @@ -0,0 +1,19 @@ +# SurfaceEllipseSigma + +## Description + +Return value: returns an array of 2 VARIANT representing of the sigma x and y values for the given ellipse area. + +## Syntax + +*object*.SurfaceEllipseSigma\(double dXPos, double dYPos, double dWidth, double dHeight\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the ellipse + +- *dYPos*: vertical coordinate of the center of the ellipse + +- *dWidth*: horizontal size of the ellipse + +- *dHeight*: vertical size of the ellipse diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelinecalculation.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelinecalculation.md new file mode 100644 index 0000000000..d4a2c19a1f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelinecalculation.md @@ -0,0 +1,35 @@ +# SurfaceLineCalculation + +## Description + +Returns an array of 3 VARIANT of the values for the given line in the following order: minimum value, maximum value, average. + +## Syntax + +*object*.SurfaceLineCalculation\(double dXPos1, double dYPos1, double dXPos2, double dYPos2, double dSampling\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos1*: horizontal coordinate of the first vertex of the line + +- *dYPos1*: vertical coordinate of the first vertex of the line + +- *dXPos2*: horizontal coordinate of the second vertex of the line + +- *dYPos2*: vertical coordinate of the second vertex of the line + +- *dSampling*: number of measurements on the map + +## Remark + +For Conoscopic map, the given line is defined by: + +- *dXPos1*: theta angle of the first vertex of the line + +- *dYPos1*: phi angle of the first vertex of the line + +- *dXPos2*: theta angle of the second vertex of the line + +- *dYPos2*: phi angle of the second vertex of the line + + **Warning:** All angle values are defined in radian. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelinecalculation2.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelinecalculation2.md new file mode 100644 index 0000000000..d1d1d17dc3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelinecalculation2.md @@ -0,0 +1,37 @@ +# SurfaceLineCalculation2 + +## Description + +Returns an array of 5 VARIANT of the values for the given line in the following order: minimum value, maximum value, average, Range X, Range Y. + +## Syntax + +*object*.SurfaceLineCalculation\(double dXPos1, double dYPos1, double dXPos2, double dYPos2, double dSampling, double dThresholdLevel\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos1*: horizontal coordinate of the first vertex of the line + +- *dYPos1*: vertical coordinate of the first vertex of the line + +- *dXPos2*: horizontal coordinate of the second vertex of the line + +- *dYPos2*: vertical coordinate of the second vertex of the line + +- *dSampling*: distance between two measurement points on the map \(for example the result returned by XSampleWidth or YSampleHeight\) + +- *dThresholdLevel*: Iso level defined to measure the range X and Y + +## Remark + +For Conoscopic map, the given line is defined by: + +- *dXPos1*: theta angle of the first vertex of the line + +- *dYPos1*: phi angle of the first vertex of the line + +- *dXPos2*: theta angle of the second vertex of the line + +- *dYPos2*: phi angle of the second vertex of the line + + **Warning:** All angle values are defined in radian. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelineexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelineexportspectrum.md new file mode 100644 index 0000000000..c4c75ae878 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelineexportspectrum.md @@ -0,0 +1,39 @@ +# SurfaceLineExportSpectrum + +## Description + +Exports the spectrum data of a measurement line to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceLineExportSpectrum(double dXPos1, double dYPos1, double dXPos2, double dYPos2, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *dXPos1*: horizontal coordinate of the first vertex of the line +- *dYPos1*: vertical coordinate of the first vertex of the line +- *dXPos2*: horizontal coordinate of the second vertex of the line +- *dYPos2*: vertical coordinate of the second vertex of the line +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates XMPViewer COM server + set XmpViewer = CreateObject("XmpViewer.application") + ' Opens XMP file + XMPViewer.OpenFile("C:\Example.xmp") + ' Exports spectrum into SPE file + XMPViewer.SurfaceLineExportSpectrum(-0.25, 0, 0.25, 0, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +XMPViewer.SurfaceLineExportSpectrum (-0.25, 0, 0.25, 0, "C:\\Example.spe") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelineexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelineexporttxt.md new file mode 100644 index 0000000000..15ac8229cb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacelineexporttxt.md @@ -0,0 +1,40 @@ +# SurfaceLineExportTXT + +## Description + +Exports values of 2D section to text file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceLineExportTXT(double dXPos1, double dYPos1, double dXPos2, double dYPos2, int iSampling, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *dXPos1*: horizontal coordinate of the first vertex of the line +- *dYPos1*: vertical coordinate of the first vertex of the line +- *dXPos2*: horizontal coordinate of the second vertex of the line +- *dYPos2*: vertical coordinate of the second vertex of the line +- *iSampling*: number of measurements along the line +- *bstrFileName*: path and filename of the text file \(should end by .TXT\). + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports values into TXT file +XMPViewer.SurfaceLineExportTXT(-4, -4, 4, 4, 50, "C:\Example.txt") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports values into TXT file +XmpViewer. SurfaceLineExportTxt(-4, -4, 4, 4, 50, "C:\\Example.txt ") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepointexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepointexportspectrum.md new file mode 100644 index 0000000000..4eec706ce8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepointexportspectrum.md @@ -0,0 +1,37 @@ +# SurfacePointExportSpectrum + +## Description + +Exports the spectrum data of a measurement point to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePointExportSpectrum(double dXPos, double dYPos, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *dXPos*: horizontal coordinate of the point +- *dYPos*: vertical coordinate of the point +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +XMPViewer.SurfacePointExportSpectrum(0, 0, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +XMPViewer.SurfacePointExportSpectrum (0, 0, "C:\\Example.spe") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonbarycentre.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonbarycentre.md new file mode 100644 index 0000000000..1a6fc08342 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonbarycentre.md @@ -0,0 +1,15 @@ +# SurfacePolygonBarycentre + +## Description + +Return value: returns an array of 2 VARIANT representing of the barycentre x and y values for the given polygonal area. + +## Syntax + +*object*.SurfacePolygonBarycentre\(VARIANT\* vPtX, VARIANT\* vPtY\) As Variant + +- *object*: Virtual Photometric Lab object + +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon + +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polygon diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygoncalculation.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygoncalculation.md new file mode 100644 index 0000000000..f91b72e4e1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygoncalculation.md @@ -0,0 +1,30 @@ +# SurfacePolygonCalculation + +## Description + +Returns an array of 10 VARIANT of the values for the given polygonal area in the following order: minimum value, x then y coordinates of the minimum value, maximum value, x then y coordinates of the maximum value, flux, average, contrast, sigma. + +## Syntax + +*object*.SurfacePolygonCalculation\(VARIANT\* vPtX, VARIANT\* vPtY\) As Variant + +- *object*: Virtual Photometric Lab object + +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon + +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polygon + +## Remark + +This function is not available for conoscopic map. + +***Example*** + +```Dim VirtualPhotometricLab As Object +Dim vPtx As Variant, vPty As Variant +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +vPtx1 = Array(3.2, 29.8, 32.7, 3.6) +vPty1 = Array(3.7, -1.5, 19.7, 24.6) +retval = VirtualPhotometricLab.OpenFile(MyPath) +PolygonRetval = VirtualPhotometricLab.SurfacePolygonCalculation(vPtx1, vPty1) +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygoncolor.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygoncolor.md new file mode 100644 index 0000000000..33887c5ad7 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygoncolor.md @@ -0,0 +1,31 @@ +# SurfacePolygonColor + +## Description + +Returns an array of 3 VARIANT representing the three components of the average color for the given ellipse area and a given polygonal system. + +## Syntax + +*object*.SurfacePolygonColor\(VARIANT\* vPtX, VARIANT\* vPtY, short iColorSystem\) As Variant + +- *object*: Virtual Photometric Lab object + +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon + +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polygon + +- *iColorSystem*: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonexport.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonexport.md new file mode 100644 index 0000000000..34ec823a94 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonexport.md @@ -0,0 +1,34 @@ +# SurfacePolygonExport + +## Description + +Exports a XMP map or a text file of the selected polygonal surface. Returns a value different from 0 if no error has occurred. + +## Syntax + +*object*.SurfacePolygonExport\(double dXPos, double dYPos, double dWidth, double dHeight, string bstrFileName, integer iFormat\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +- *bstrFileName*: path and filename of the output file. Should end by **.xmp** for XMP map or **.txt** for a text file. + +- *iFormat*: format of the output file, 0 for text file, 1 for XMP map. + +***Example*** + +```Dim VirtualPhotometricLab As Object +Dim vPtx1 As Variant, vPty1 As Variant +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +vPtx1 = Array(-10, 10, 10, -10) +vPty1 = Array(-15, -15, 15, 15) +retval = VirtualPhotometricLab.OpenFile(MyPath) +PolygonRetval = XMPviewer.SurfacePolygonExport(vPtx1, vPty1, MySurfacePolygonExport, 0) +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonexportspectrum.md new file mode 100644 index 0000000000..1b6e0ae9b4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonexportspectrum.md @@ -0,0 +1,26 @@ +# SurfacePolygonExportSpectrum + +## Description + +Exports the spectrum data of a measurement polygon to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePolygonExportSpectrum(VARIANT* vPtX, VARIANT* vPtY, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polygon +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +vPtx = array(-0.3, 0.3, 0.3, -0.3) +vPty = array(-0.3, -0.3, 0.3, 0.3) +XMPViewer.SurfacePolygonExportSpectrum(vPtx, vPty, "C:\Example.spe") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygongeneralcri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygongeneralcri.md new file mode 100644 index 0000000000..eb958db36f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygongeneralcri.md @@ -0,0 +1,28 @@ +# SurfacePolygonGeneralCRI + +## Description + +Returns the general color rendering index for the given polygon area + +## Syntax + +*object*.SurfacePolygonGeneralCRI\(VARIANT\* vPtX, VARIANT\* vPtY, VARIANT\* vdCRI\) As Short + +- *object*: Virtual Photometric Lab object + +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon + +- *vPtY*: vertical coordinate of the center of the ellipse + +- *vdCRI*: array of VARIANT for the vertical coordinate of each vertex of the polygon + +***Example*** + +```Dim VirtualPhotometricLab As Object +Dim vPtx As Variant, vPty As Variant, vdCRI as Variant +Set VirtualPhotometricLab = CreateObject("XmpViewer.Application") +vPtx1 = Array(3.2, 29.8, 32.7, 3.6) +vPty1 = Array(3.7, -1.5, 19.7, 24.6) +retval = VirtualPhotometricLab.OpenFile(MyPath) +PolygonRetval = VirtualPhotometricLab.SurfacePolygonGeneralCRI(vPtx1, vPty1, vdCRI) +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonsigma.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonsigma.md new file mode 100644 index 0000000000..a0e9179f46 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolygonsigma.md @@ -0,0 +1,15 @@ +# SurfacePolygonSigma + +## Description + +Return value: returns an array of 2 VARIANT representing of the sigma x and y values for the given polygonal area. + +## Syntax + +*object*.SurfacePolygonSigma\(VARIANT\* vPtX, VARIANT\* vPtY\) As Variant + +- *object*: Virtual Photometric Lab object + +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polygon + +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polygon diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolylineexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolylineexportspectrum.md new file mode 100644 index 0000000000..478fffbe14 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolylineexportspectrum.md @@ -0,0 +1,26 @@ +# SurfacePolylineExportSpectrum + +## Description + +Exports the spectrum data of a measurement polyline to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePolylineExportSpectrum(VARIANT* vPtX, VARIANT* vPtY, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polyline +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polyline +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +vPtx = array(-0.3, 0.3, 0.3, -0.3) +vPty = array(-0.3, -0.3, 0.3, 0.3) +XMPViewer.SurfacePolylineExportSpectrum(vPtx, vPty, "C:\Example.spe") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolylineexporttxt.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolylineexporttxt.md new file mode 100644 index 0000000000..8ebca04c73 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacepolylineexporttxt.md @@ -0,0 +1,27 @@ +# SurfacePolylineExportTXT + +## Description + +Exports values of 2D polyline to a text file format. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfacePolylineExportTXT(VARIANT* vPtX, VARIANT* vPtY, int iSampling, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *vPtX*: array of VARIANT for the horizontal coordinate of each vertex of the polyline +- *vPtY*: array of VARIANT for the vertical coordinate of each vertex of the polyline +- *iSampling*: number of measurements along the polyline +- *bstrFileName*: path and filename of the text \(.txt\) file. + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports values into TXT file +vPtx = array(-4, -4, 4, 4) +vPty = array(-4, 4, -4, 4) +XMPViewer.SurfacePolylineExportTXT(vPtx, vPty, 50, "C:\Example.txt") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglebarycentre.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglebarycentre.md new file mode 100644 index 0000000000..ae72541a1d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglebarycentre.md @@ -0,0 +1,33 @@ +# SurfaceRectangleBarycentre + +## Description + +Return value: returns an array of 2 VARIANT representing of the barycentre x and y values for the given rectangle area. + +## Syntax + +*object*.SurfaceRectangleBarycentre\(double dXPos, double dYPos, double dWidth, double dHeight\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +## Remark + +For Conoscopic map, the given area is a corona defined by: + +- *dXPos*: Minimum value of the theta angle + +- *dYPos*: Maximum value of the theta angle + +- *dWidth*: Minimum value of the phi angle + +- *dHeight*: Maximum value of the phi angle + + **Warning:** All angle values are defined in radian. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglecalculation.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglecalculation.md new file mode 100644 index 0000000000..0849d38eed --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglecalculation.md @@ -0,0 +1,65 @@ +# SurfaceRectangleCalculation + +## Description + +Returns an array of 16 VARIANT of the values for the given rectangle area in the following order: + +1. Minimum value + +2. Minimum value X coordinate + +3. Minimum value Y coordinate + +4. Maximum value + +5. Maximum value X coordinate + +6. Maximum value Y coordinate + +7. Flux + +8. Average + +9. Contrast + +10. Sigma + +11. Barycenter X coordinate + +12. Barycenter Y coordinate + +13. Sigma X coordinate + +14. Sigma Y coordinate + +15. RMS Contrast + +16. Eye Irradiance + +## Syntax + +*object*.SurfaceRectangleCalculation\(double dXPos, double dYPos, double dWidth, double dHeight\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +## Remark + +For Conoscopic map, the given area is a corona defined by: + +- *dXPos*: Minimum value of the theta angle + +- *dYPos*: Maximum value of the theta angle + +- *dWidth*: Minimum value of the phi angle + +- *dHeight*: Maximum value of the phi angle + + **Warning:** All angle values are defined in radian. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglecolor.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglecolor.md new file mode 100644 index 0000000000..c928ce53b9 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglecolor.md @@ -0,0 +1,49 @@ +# SurfaceRectangleColor + +## Description + +Returns an array of 3 VARIANT representing the three components of the average color for the given ellipse area and a given rectangle system. + +## Syntax + +*object*.SurfaceRectangleColor\(double dXPos, double dYPos, double dWidth, double dHeight, short iColorSystem\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +- *iColorSystem*: colorimetric system + + 0: COLOR\_SYSTEM\_XYZ + + 1: COLOR\_SYSTEM\_xyY + + 2: COLOR\_SYSTEM\_uvY\_CIE1960 + + 3: COLOR\_SYSTEM\_uvY\_CIE1976 + + 4: COLOR\_SYSTEM\_Luv + + 5: COLOR\_SYSTEM\_Lab + + 6: COLOR\_SYSTEM\_LCh + +## Remark + +For Conoscopic map, the given area is a corona defined by: + +- *dXPos*: Minimum value of the theta angle + +- *dYPos*: Maximum value of the theta angle + +- *dWidth*: Minimum value of the phi angle + +- *dHeight*: Maximum value of the phi angle + + **Warning:** All angle values are defined in radian. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectangleexport.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectangleexport.md new file mode 100644 index 0000000000..5dec6d1f01 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectangleexport.md @@ -0,0 +1,23 @@ +# SurfaceRectangleExport + +## Description + +Exports a XMP map or a text file of the selected rectangular surface. Returns a value different from 0 if no error occurred. + +## Syntax + +*object*.SurfaceRectangleExport \(double dXPos, double dYPos, double dWidth, double dHeight, string bstrFileName, integer iFormat\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +- *bstrFileName*: path and filename of the output file. Should end by **.xmp** for XMP map or **.txt** for a text file. + +- *iFormat*: format of the output file, 0 for text file, 1 for XMP map. diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectangleexportspectrum.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectangleexportspectrum.md new file mode 100644 index 0000000000..61c64340e0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectangleexportspectrum.md @@ -0,0 +1,39 @@ +# SurfaceRectangleExportSpectrum + +## Description + +Exports the spectrum data of a measurement rectangle to a spectrum file. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SurfaceRectangleExportSpectrum(double dXPos, double dYPos, double dWidth, double dHeight, BSTR bstrFileName)` as Boolean +- *object*: Virtual Photometric Lab +- *dXPos*: horizontal coordinate of the center of the rectangle \(Theta start for conoscopic map\) +- *dYPos*: vertical coordinate of the center of the rectangle \(Theta end for conoscopic map\) +- *dWidth*: horizontal size of the rectangle \(Phi start for conoscopic map\) +- *dHeight*: vertical size of the rectangle \(Phi end for conoscopic map\) +- *bstrFileName*: path and filename of the spectrum \(.spectrum, .spe\) file. + +## VB script example + +```VB +' Creates XMPViewer COM server +set XmpViewer = CreateObject("XmpViewer.application") +' Opens XMP file +XMPViewer.OpenFile("C:\Example.xmp") +' Exports spectrum into SPE file +XMPViewer.SurfaceRectangleExportSpectrum(0, 0, 0.5, 0.5, "C:\Example.spe") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates XMPViewer COM server +type = Type.GetTypeFromProgID("XmpViewer.Application") +XmpViewer = Activator.CreateInstance(type) +# Opens XMP file +XmpViewer.OpenFile("C:\\Example.xmp") +# Exports spectrum +XMPViewer.SurfaceRectangleExportSpectrum ( 0, 0, 0.5, 0.5, "C:\\Example.spe") +``` diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglegeneralcri.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglegeneralcri.md new file mode 100644 index 0000000000..b9ee8a6a17 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglegeneralcri.md @@ -0,0 +1,21 @@ +# SurfaceRectangleGeneralCRI + +## Description + +Returns the general color rendering index for the given rectangle area. + +## Syntax + +*object*.SurfaceRectangleGeneralCRI\(double dXPos, double dYPos, double dWidth, double dHeight, VARIANT\* vdCRI\) As Short + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +- *vdCRI*: general color rendering index value diff --git a/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglesigma.md b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglesigma.md new file mode 100644 index 0000000000..6d27936eac --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_photometric_lab/surface_calculation_on_map/labvp_surfacerectanglesigma.md @@ -0,0 +1,33 @@ +# SurfaceRectangleSigma + +## Description + +Return value: returns an array of 2 VARIANT representing of the sigma x and y values for the given rectangle area. + +## Syntax + +*object*.SurfaceRectangleBarycentre\(double dXPos, double dYPos, double dWidth, double dHeight\) As Variant + +- *object*: Virtual Photometric Lab object + +- *dXPos*: horizontal coordinate of the center of the rectangle + +- *dYPos*: vertical coordinate of the center of the rectangle + +- *dWidth*: horizontal size of the rectangle + +- *dHeight*: vertical size of the rectangle + +## Remark + +For Conoscopic map, the given area is a corona defined by: + +- *dXPos*: Minimum value of the theta angle + +- *dYPos*: Maximum value of the theta angle + +- *dWidth*: Minimum value of the phi angle + +- *dHeight*: Maximum value of the phi angle + + **Warning:** All angle values are defined in radian. diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_basic_methods.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_basic_methods.md new file mode 100644 index 0000000000..f74d31d779 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_basic_methods.md @@ -0,0 +1,4 @@ +# Basic methods + +- [OpenFile](labvr_openfile.md) +- [SaveFile](labvr_savefile.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_openfile.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_openfile.md new file mode 100644 index 0000000000..2dcaa6d292 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_openfile.md @@ -0,0 +1,36 @@ +# OpenFile + +## Description + +Opens a Speos360 file. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OpenFile\(BSTR *strFileName*\) As Int + +- *object*: Virtual Reality Lab object + +- *strFileName*: absolute filename string + + +## Example + +``` +Sub OpenFile() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +MsgBox ("File opened") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_savefile.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_savefile.md new file mode 100644 index 0000000000..05fab2bef8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/basic_methods/labvr_savefile.md @@ -0,0 +1,37 @@ +# SaveFile + +## Description + +Saves an Speos360 file. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SaveFile\(BSTR *strFileName*\) As Int + +- *object*: Virtual Reality Lab object + +- *strFileName*: absolute filename string + + +## Example + +``` +Sub SaveFile() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Modify File +Error = VirtualRealityLab.SetSourcePowerById(0, 100) +'Save File +Error = VirtualRealityLab.SaveFile("U:\AMT\API VRLab\InteriorCar_Saved.speos360") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_configurations.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_configurations.md new file mode 100644 index 0000000000..e2cbe5b7a2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_configurations.md @@ -0,0 +1,8 @@ +# Configurations + +- [GetNbConfigurations](labvr_getnbconfigurations.md) +- [SetConfigurationById](labvr_setconfigurationbyid.md) +- [SetConfigurationByName](labvr_setconfigurationbyname.md) +- [CreateConfig](labvr_createconfig.md) +- [GetConfigName](labvr_getconfigname.md) +- [SetConfigName](labvr_setconfigname.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_createconfig.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_createconfig.md new file mode 100644 index 0000000000..b70a619922 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_createconfig.md @@ -0,0 +1,38 @@ +# CreateConfig + +## Description + +Creates a new configuration. The name of the new configuration must be unique and not empty. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.CreateConfig(BSTR bstrConfigName)` as Boolean +- *object*: Virtual Reality Lab +- *bstrConfigName*: name of the new configuration + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application") +' Opens Speos360 file +HDRIViewer.OpenFile("C:\Example.speos360") +' Creates a new configuration +HDRIViewer.CreateConfig("My Configuration") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates HDRIViewer COM server +type = Type.GetTypeFromProgID("HDRIViewer.application") +HDRIViewer = Activator.CreateInstance(type) +#Opens observer Speos360 file +strSpeos360File = "C:\\ObserverView_Stereo.speos360" +HDRIViewer.OpenFile(strSpeos360File) +# Creates a new configuration +XmpViewer.HDRIViewer ("My Configuration") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_getconfigname.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_getconfigname.md new file mode 100644 index 0000000000..e75cec9942 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_getconfigname.md @@ -0,0 +1,49 @@ +# GetConfigName + +## Description + +Gets the name of the configuration number N. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.GetConfigName(int iConfig, VARIANT* ovConfigName)` as Boolean +- *object*: Virtual Reality Lab +- *iConfig*: index of the configuration in Virtual Lighting Controller \(starting from 0\) +- *ovConfigName*: configuration name + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application") +' Opens Speos360 file +HDRIViewer.OpenFile("C:\Example.speos360") +' Gets the name of the configuration 3 +Dim sConfigName +HDRIViewer.GetConfigName(3, sConfigName) +' Prints the name of the configuration 3 +Dim ConfigName as String +ConfigName = sConfigName(1) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates HDRIViewer COM server +type = Type.GetTypeFromProgID("HDRIViewer.application") +HDRIViewer = Activator.CreateInstance(type) +#Opens observer Speos360 file +strSpeos360File = "C:\\ObserverView_Stereo.speos360" +HDRIViewer.OpenFile(strSpeos360File) +# Gets the name of the configuration number 3 +sConfigName = clr.Reference[System.Object]() #Creates a default pointer +retval = HDRIViewer.GetConfigName(2, sConfigName) +# Prints the name of the configuration number 3 +configName = sConfigName.Value +print configName[0] +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_getnbconfigurations.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_getnbconfigurations.md new file mode 100644 index 0000000000..b125bfb84a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_getnbconfigurations.md @@ -0,0 +1,37 @@ +# GetNbConfigurations + +## Description + +Returns the number of configurations defined in the Virtual Lighting Controller. + +## Syntax + +*object*.GetNbConfigurations\(\) As Int + +- *object*: Virtual Reality Lab object + + +## Example + +``` +Sub GetNbConfigurations() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Evaluate the Number of Configurations +Dim ConfigurationNumber +ConfigurationNumber = VirtualRealityLab.GetNbConfigurations() +MsgBox ("Configuration(s): " & ConfigurationNumber) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigname.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigname.md new file mode 100644 index 0000000000..5e00a6b358 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigname.md @@ -0,0 +1,41 @@ +# SetConfigName + +## Description + +Sets the name of a configuration. The new name of the configuration must be unique. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.GetConfigName(int iConfig, VARIANT* ovConfigName)` as Boolean +- *object*: Virtual Reality Lab +- *iConfig*: index of the configuration in Virtual Lighting Controller \(starting from 0\) +- *bstrConfigName*: new configuration name + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application") +' Opens Speos360 file +HDRIViewer.OpenFile("C:\Example.speos360") +' Sets the name of the configuration 3 +HDRIViewer.SetConfigName(3, "My Configuration") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates HDRIViewer COM server +type = Type.GetTypeFromProgID("HDRIViewer.application") +HDRIViewer = Activator.CreateInstance(type) +#Opens observer Speos360 file +strSpeos360File = "C:\\ObserverView_Stereo.speos360" +HDRIViewer.OpenFile(strSpeos360File) +# Sets the name of the configuration number 3 +retval = HDRIViewer.SetConfigName(2, “My Configuration”) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigurationbyid.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigurationbyid.md new file mode 100644 index 0000000000..cf5d9daa01 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigurationbyid.md @@ -0,0 +1,43 @@ +# SetConfigurationById + +## Description + +Activates a specific configuration using its index. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetConfigurationById\(int *uiIDConfiguration*\) As Int + +- *object*: Virtual Reality Lab object + +- *uiIDConfiguration*: Index of the configuration on the Virtual Lighting Controller starting from 0 + + +## Example + +``` +Sub SetConfigurationById() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Activate the first Configuration +Error = VirtualRealityLab.SetConfigurationById(0) +MsgBox ("First Configuration Set") +'Activate the second Configuration +Error = VirtualRealityLab.SetConfigurationById(1) +MsgBox ("Second Configuration Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigurationbyname.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigurationbyname.md new file mode 100644 index 0000000000..9b19d86f7a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/configurations/labvr_setconfigurationbyname.md @@ -0,0 +1,43 @@ +# SetConfigurationByName + +## Description + +Activates a specific configuration using its name. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetConfigurationByName\(BSTR *strConfigurationName*\) As Int + +- *object*: Virtual Reality Lab object + +- *strConfigurationName*: string for the name of the configuration from the Virtual Lighting Controller + + +## Example + +``` +Sub SetConfigurationByName() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Activate the Configuration named "Day" +Error = VirtualRealityLab.SetConfigurationByName("Day") +MsgBox ("Day Configuration Set") +'Activate the Configuration named "Night" +Error = VirtualRealityLab.SetConfigurationByName("Night") +MsgBox ("Night Configuration Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_display.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_display.md new file mode 100644 index 0000000000..0b83cca695 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_display.md @@ -0,0 +1,8 @@ +# Display + +- [Show](labvr_show.md) +- [FullScreen](labvr_fullscreen.md) +- [SetAutomaticUpdate](labvr_setautomaticupdate.md) +- [Update](labvr_update.md) +- [SetAlwaysOnTop](labvr_setalwaysontop.md) +- [SetSightDirection](labvr_setsightdirection.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_fullscreen.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_fullscreen.md new file mode 100644 index 0000000000..fca7cf6790 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_fullscreen.md @@ -0,0 +1,38 @@ +# FullScreen + +## Description + +Activates or deactivates the full screen mode. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.FullScreen\(bool *bState*\) As Int + +- *object*: Virtual Reality Lab object + +- *bState:* Boolean activating/deactivating the full screen mode. + + +## Example + +``` +Sub FullScreen() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'FullScreenVRLab +Error = VirtualRealityLab.FullScreen(True) +MsgBox ("VRLab FullScreen") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setalwaysontop.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setalwaysontop.md new file mode 100644 index 0000000000..2c78e72b0c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setalwaysontop.md @@ -0,0 +1,43 @@ +# SetAlwaysOnTop + +## Description + +Set the window always on the top of the screen. **True** by default. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetAlwaysOnTop\(short *bAlwaysOnTop*\) As Int + +- *object*: Virtual Reality Lab object + +- *bAlwaysOnTop:*boolean being **True** to set the window always on the top or **False** else + + +## Example + +``` +Sub SetAlwaysOnTop() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Set the window always on the back +Error = VirtualRealityLab.SetAlwaysOnTop(False) +MsgBox ("VRLab on the Back") +'Set the window always on the top +Error = VirtualRealityLab.SetAlwaysOnTop(True) +MsgBox ("VRLab on the Top") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setautomaticupdate.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setautomaticupdate.md new file mode 100644 index 0000000000..555108416d --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setautomaticupdate.md @@ -0,0 +1,51 @@ +# SetAutomaticUpdate + +## Description + +Activates \(**True**\) or deactivates \(**False**\) the automatic update of the visualization. **True** by default. + +When activated, the update is carried out after any method and the **Update** method has no use. When deactivated, the update is carried out each time that the **Update** method is used. + +This method allows you to execute a group of instructions at one time. Irrelevant changes in the visualization can be avoided this way. + +Returns a value different from 0 if no error occurred. + +## Syntax + +*object*.SetAutomaticUpdate\(bool *bAutomaticUpdate*\) As Int + +- *object*: Virtual Reality Lab object + +- *bAutomaticUpdate*: boolean being **True** to activate or **False** to deactivate + + +## Example + +``` +Sub SetAutomaticUpdate_And_Update() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Before Update") +'Deactivate Automatic Update +Error = VirtualRealityLab.SetAutomaticUpdate(False) +'Group of instructions to execute (setting the power of some sources) +Error = VirtualRealityLab.SetSourcePowerById(0, 100) +Error = VirtualRealityLab.SetSourcePowerById(1, 120) +Error = VirtualRealityLab.SetSourcePowerById(2, 150) +' Update the visualization +Error = VirtualRealityLab.Update() +MsgBox ("After Update") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setsightdirection.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setsightdirection.md new file mode 100644 index 0000000000..464c7d22df --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_setsightdirection.md @@ -0,0 +1,60 @@ +# SetSightDirection + +## Description + +Change the sight direction on immersive and observer views. + +Returns 1 in all the cases \(no error management\). + +**Note:** + +If the theta and phi angles specified match to an impossible position, the closest position is reached instead. + +## Syntax + +*object*.SetSightDirection\(*theta*As Double, *phi*As Double\) As Long + +- *object*: Virtual Reality Lab object + +- *theta :*angle driving the horizontal orientation \(rad\) + +- *phi:*angle driving the vertical orientation \(rad\) + + +**Note:** + +Theta and phi angles definitions are inverted when the method is used with immersive sensors. + +**Note:** + +The interval of definition of the theta and phi angles is \]-inf;inf\[. + +## Example + +``` +Sub main() +' Error Management +Dim Error As Integer +' Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +' Show VRLab +Error = VirtualRealityLab.Show(True) +' Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +' Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +' Initialize the initial sight direction +Dim Theta, Phi As Double +Theta = 0 +Phi = 0 +' Make the sight direction sweeping horizontally from 0 to 360deg +While Theta < 360 * 3.14 / 180 + Error = VirtualRealityLab.SetSightDirection(Theta, Phi) + Theta = Theta + 1 * 3.14 / 180 ' Angular step of 1deg +Wend +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_show.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_show.md new file mode 100644 index 0000000000..44cbe68283 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_show.md @@ -0,0 +1,38 @@ +# Show + +## Description + +Displays or hides the window for an instance of Virtual Reality Lab. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.Show\(bool *bDraw*\) As Int + +- *object*: Virtual Reality Lab object + +- *bDraw*: boolean being **True** to display or **False** to hide + + +## Example + +``` +Sub Show() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Show VRLab +Error = VirtualRealityLab.Show(True) +MsgBox ("VRLab shown") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_update.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_update.md new file mode 100644 index 0000000000..a147ab0acb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/display/labvr_update.md @@ -0,0 +1,45 @@ +# Update + +## Description + +Updates the visualization. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.Update\(\) As Int + +- *object*: Virtual Reality Lab object + + +## Example + +``` +Sub SetAutomaticUpdate_And_Update() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Before Update") +'Deactivate Automatic Update +Error = VirtualRealityLab.SetAutomaticUpdate(False) +'Group of instructions to execute (setting the power of some sources) +Error = VirtualRealityLab.SetSourcePowerById(0, 100) +Error = VirtualRealityLab.SetSourcePowerById(1, 120) +Error = VirtualRealityLab.SetSourcePowerById(2, 150) +' Update the visualization +Error = VirtualRealityLab.Update() +MsgBox ("After Update") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportallobserverimages.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportallobserverimages.md new file mode 100644 index 0000000000..512ceb6d57 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportallobserverimages.md @@ -0,0 +1,40 @@ +# ExportAllObserverImages + +## Description + +This function allows you to export all the sight views as pictures, in native resolution \(not the displayed one\) with the current VLC, color scale and human vision settings. The current file must be an observer Speos360 and the HMI has to be displayed with the Show method. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +*object*.ExportAllObserverImages\(BSTR bstrDirectoryPath, int iFormat\) as Boolean + +- *object*: Virtual Reality Lab object + +- *BSTR DirectoryPath*: path of the directory where the result is stored + +- *iFormat*: image format \(0: JPG, 1: PNG, 2: EXR, 3: HDR\) +- Bool return + - True: success + - False: fail + +## Example + +``` +'Create HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application")' Displays the HMI +HDRIViewer.Show(True) +'Opens observer OptisVR file +HDRIViewer.OpenFile("C:\ObserverView_Stereo.OptisVR") +'Exports image JPG +HDRIViewer.ExportAllObserverImages("C:\", 0) +'Exports image EXR +HDRIViewer.ExportAllObserverImages("C:\", 2) +'Sets right eye +HDRIViewer.SetRightEye() +'Exports image PNG +HDRIViewer.ExportAllObserverImages("C:\", 1) +'Exports image HDR +HDRIViewer.ExportAllObserverImages("C:\", 3) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportcurrentviewtoxmp.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportcurrentviewtoxmp.md new file mode 100644 index 0000000000..bf220d0bb2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportcurrentviewtoxmp.md @@ -0,0 +1,46 @@ +# ExportCurrentViewToXMP + +## Description + +This function allows you to export the Current view of the opened \*.OptisVR or \*.Speos360 file in XMP format. + +## Syntax + +*object*.ExportCurrentViewToXMP\(BSTR strOutputNameFile\) As Bool + +- *object*: Virtual Reality Lab object + +- *BSTR strOutputFileName*: This variable is composed of the path, the filename and the extension + +- Bool return + - True: success + - False: fail + +## Example + +``` +Sub ExportCurrentViewToXMP() +'ReturnValue Management +Dim ReturnValue As Bool +'Declare Virtual Reality Lab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Check if the object is created +Dim CheckErrorCreateObject +CheckErrorCreateObject = VirtualRealityLab.GetPID() +if(CheckErrorCreateObject = empty) then + MsgBox ("Creation of object failed") +else + 'Show Virtual Reality Lab + ReturnValue = VirtualRealityLab.Show(True) + 'Open File + ReturnValue = VirtualRealityLab.OpenFile("C:\username\API VRLab\InteriorCar.speos360") + 'Export Speos360 file current view to XMP file + ReturnValue = VirtualRealityLab.ExportCurrentViewToXMP("C:\username\API VRLab\InteriorCar.xmp") + MsgBox ("Export complete") +end if +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exporting_data.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exporting_data.md new file mode 100644 index 0000000000..9488508dcb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exporting_data.md @@ -0,0 +1,5 @@ +# Exporting data + +- [ExportCurrentViewToXM](labvr_exportcurrentviewtoxmp.md) +- [ExportObserverImage](labvr_exportobserverimage.md) +- [ExportAllObserverImages](labvr_exportallobserverimages.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportobserverimage.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportobserverimage.md new file mode 100644 index 0000000000..1f0a40e3c8 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/exporting_data/labvr_exportobserverimage.md @@ -0,0 +1,55 @@ +# ExportObserverImage + +## Description + +Exports the current view as a picture, in native resolution \(not the displayed one\) with the current VLC, color scale and human vision settings. The current file must be an observer Speos360 and the HMI has to be displayed with the Show method. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.ExportObserverImage(BSTR bstrFileName)` as Boolean +- *object*: Virtual Reality Lab +- *bstrFileName*: path and filename of the .JPG, .PNG, .EXR or .HDR files + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application") +' Displays the HMI +HDRIViewer.Show(True) +' Opens observer Speos360 file +HDRIViewer.OpenFile("C:\ObserverView_Stereo.speos360") +' Exports image JPG +HDRIViewer.ExportObserverImage("C:\ObserverView_Stereo.JPG") +' Exports image PNG +HDRIViewer.ExportObserverImage("C:\ObserverView_Stereo.PNG") +' Exports image EXR +HDRIViewer.ExportObserverImage("C:\ObserverView_Stereo.EXR") +' Exports image HDR +HDRIViewer.ExportObserverImage("C:\ObserverView_Stereo.HDR") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates HDRIViewer COM server +type = Type.GetTypeFromProgID("HDRIViewer.application") +HDRIViewer = Activator.CreateInstance(type) +#Opens observer Speos360 file +strSpeos360File = "C:\\ObserverView_Stereo.speos360" +HDRIViewer.OpenFile(strSpeos360File) +#Displays the HMI +HDRIViewer.Show(True) +#Exports image JPG +HDRIViewer.ExportObserverImage("C:\\ObserverView_Stereo.JPG") +#Exports image PNG +HDRIViewer.ExportObserverImage("C:\\ObserverView_Stereo.PNG") +#Exports image EXR +HDRIViewer.ExportObserverImage("C:\\ObserverView_Stereo.EXR") +#Exports image HDR +HDRIViewer.ExportObserverImage("C:\\ObserverView_Stereo.HDR") + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activateglare.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activateglare.md new file mode 100644 index 0000000000..f2485300b0 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activateglare.md @@ -0,0 +1,41 @@ +# ActivateGlare + +## Description + +Activates the Vos \(1984\) glare effect. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*. ActivateGlare \(bool *bActivated*\) + +- *object* : Virtual Reality Lab object. + +- *bActivated*: true to active glare else false. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Active glare effect +Error = VirtualRealityLab.ActivateGlare(true) +MsgBox ("Glare activated") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatehumanvision.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatehumanvision.md new file mode 100644 index 0000000000..0403fe7600 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatehumanvision.md @@ -0,0 +1,41 @@ +# ActivateHumanVision + +## Description + +Activates or deactivates the Human Vision mode. + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.ActivateHumanVision\(bool *bActivated*\) + +- *object* : Virtual Reality Lab object + +- *bActivated*: Boolean activating/deactivating the Human Vision mode. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Deactivate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(false) +MsgBox ("Human Vision deactivated") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatelocaladaptationautomatic.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatelocaladaptationautomatic.md new file mode 100644 index 0000000000..b92b69fcd5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatelocaladaptationautomatic.md @@ -0,0 +1,39 @@ +# ActivateLocalAdaptationAutomatic + +## Description + +Activates the automatic mode for Local Adaptation. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*. ActivateLocalAdaptationAutomatic\(bool *bActivated*\) + +- *object* : Virtual Reality Lab object. + +- *bActivated*: boolean activating/deactivating the automatic mode for Local Adaptation. + + - **True**: activate + + - **False**: deactivate + + +## Example + +``` +Sub HumanVision() +'Error Management Dim Error As Integer +'Declare VRLab Dim VirtualRealityLab As Object Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab Error = VirtualRealityLab.Show(True) +'Open File Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision Error = VirtualRealityLab.ActivateHumanVision(true) MsgBox ("Human Vision activated") +'Set mode Local Adaptation Error = VirtualRealityLab.SetAdaptationType(0) MsgBox ("Human vision mode changed to Local Adaptation") +'Set automatic adaptation +Error = VirtualRealityLab.ActivateLocalAdaptationAutomatic(true) +MsgBox ("Automatic mode for Local Adaptation enabled") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatetemporaladaptation.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatetemporaladaptation.md new file mode 100644 index 0000000000..c3734363c6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatetemporaladaptation.md @@ -0,0 +1,48 @@ +# ActivateTemporalAdaptation + +## Description + +Activates the temporal adaption mode for Dynamic Adaptation mode. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.ActivateTemporalAdaptation \(bool *bActivated*\) + +- *object* : Virtual Reality Lab object. + +- *bActivated*: boolean activating/deactivating the temporal adaption mode + + - **True**: activate + + - **False**: deactivate. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Set mode Dynamic Adaptation +Error = VirtualRealityLab.SetAdaptationType(1) +MsgBox ("Human vision mode changed to Dynamic Adaptation") +'Activate temporal adaptation mode +Error = VirtualRealityLab.ActivateTemporalAdaptation(true) +MsgBox ("Temporal Adaptation mode activated") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatevisionmodeevaluationtypeaverage.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatevisionmodeevaluationtypeaverage.md new file mode 100644 index 0000000000..c41e04f8c5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_activatevisionmodeevaluationtypeaverage.md @@ -0,0 +1,47 @@ +# ActivateVisionModeEvaluationTypeAverage + +## Description + +Changes the mesopic vision mode evaluation type from maximum luminance of the map to average luminance of the map. + +This define how the photopic, mesopic or scotopic vision mode is estimated. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.ActivateVisionModeEvaluationTypeAverage\(bool bActivated\) + +- *object* : Virtual Reality Lab object. + +- *bActivated*: boolean activating/deactivating the average evaluation + + - **True**: activate + + - **False**: deactivate. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Change vision mode evaluation to average +Error = VirtualRealityLab.ActivateVisionModeEvaluationTypeAverage(true) +MsgBox ("Vision mode average evaluation activated") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_human_vision.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_human_vision.md new file mode 100644 index 0000000000..7f499ae0ef --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_human_vision.md @@ -0,0 +1,13 @@ +# Human vision + +- [ActivateHumanVision](labvr_activatehumanvision.md) +- [SetAdaptationType](labvr_setadaptationtype.md) +- [SetLocalAdaptationLuminance](labvr_setlocaladaptationluminance.md) +- [SetLocalAdaptationLuminanceMax](labvr_setlocaladaptationluminancemax.md) +- [ActivateLocalAdaptationAutomatic](labvr_activatelocaladaptationautomatic.md) +- [SetLocalAdaptationDefaultLuminance](labvr_setlocaladaptationdefaultluminance.md) +- [ActivateTemporalAdaptation](labvr_activatetemporaladaptation.md) +- [ActivateVisionModeEvaluationTypeAverage](labvr_activatevisionmodeevaluationtypeaverage.md) +- [ActivateGlare](labvr_activateglare.md) +- [SetObserverAge](labvr_setobserverage.md) +- [HumanVisionMode](labvr_humanvisionmode.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_humanvisionmode.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_humanvisionmode.md new file mode 100644 index 0000000000..06afeedec1 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_humanvisionmode.md @@ -0,0 +1,57 @@ +# HumanVisionMode + +## Description + +Activates or deactivates the Human Vision mode and defines its main parameters. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object.*HumanVisionMode\(bool *bActive*, bool *bGlare*, int *iAge*\) As Int + +- *object*: Virtual Reality Lab object + +- *bActive*: boolean activating/deactivating the Human Vision Mode + + - **True**: activate + + - **False**: deactivate + +- *bGlare*: boolean activating/deactivating the Glare Effect + + - **True**: activate + + - **False**: deactivate + +- *iAge*: integer for the age of the observer + + +## Example + +``` +Sub HumanVisionMode() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Deactivate Human Vision & Glare Effect for a 25-year observer +Error = VirtualRealityLab.HumanVisionMode(False, False, 25) +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Human Vision deactivated") +'Activate Human Vision & Glare Effect for a 25-year observer +Error = VirtualRealityLab.HumanVisionMode(True, True, 25) +'Set Local Adaptation +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Human Vision activated") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setadaptationtype.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setadaptationtype.md new file mode 100644 index 0000000000..b84cb00e51 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setadaptationtype.md @@ -0,0 +1,41 @@ +# SetAdaptationType + +## Description + +Sets the human vision mode \(local or dynamic\). + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.SetAdaptationType\(int *nAdaptationType*\) + +- *object* : Virtual Reality Lab object. + +- *nAdaptationType*: 0 for Local Adaptation, 1 for Dynamic Adaptation. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Change mode to Dynamic Adaptation +Error = VirtualRealityLab.SetAdaptationType(1) +MsgBox ("Human vision mode changed to Dynamic Adaptation") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationdefaultluminance.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationdefaultluminance.md new file mode 100644 index 0000000000..fcb242a8a4 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationdefaultluminance.md @@ -0,0 +1,42 @@ +# SetLocalAdaptationDefaultLuminance + +## Description + +Resets the default adaptation value for Local Adaptation mode. + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.SetLocalAdaptationDefaultLuminance\(\) + +- *object* : Virtual Reality Lab object. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Set mode Local Adaptation +Error = VirtualRealityLab.SetAdaptationType(0) +MsgBox ("Human vision mode changed to Local Adaptation") +'Set adaptation luminance to default value +Error = VirtualRealityLab.SetLocalAdaptationDefaultLuminance() +MsgBox ("Adaptation luminance reset to default value") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationluminance.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationluminance.md new file mode 100644 index 0000000000..0d44e3d779 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationluminance.md @@ -0,0 +1,44 @@ +# SetLocalAdaptationLuminance + +## Description + +Sets the adaptation luminance for Local Adaptation without Automatic mode activated. + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.SetLocalAdaptationLuminance\(double *dLuminanceAdaptation*\) + +- *object* : Virtual Reality Lab object. + +- *dLuminanceAdaptation*: adaptation value in Cd/m². + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Set mode Local Adaptation +Error = VirtualRealityLab.SetAdaptationType(0) +MsgBox ("Human vision mode changed to Local Adaptation") +'Set adaptation luminance to 100 Cd/m² +Error = VirtualRealityLab.SetLocalAdaptationLuminance(100.0) +MsgBox ("Adaptation luminance changed to 100.0 Cd/m²") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationluminancemax.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationluminancemax.md new file mode 100644 index 0000000000..9529626599 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setlocaladaptationluminancemax.md @@ -0,0 +1,46 @@ +# SetLocalAdaptationLuminanceMax + +## Description + +Sets the maximum adaptation luminance for Local Adaptation without Automatic mode activated. + +Returns 1 if the call succeeded, 0 otherwise. + +## Syntax + +*object*.SetLocalAdaptationLuminanceMax\(double *dLuminanceMax*\) + +- *object* : Virtual Reality Lab object. + +- *dLuminanceMax*: maximum adaptation value in Cd/m². + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Set mode Local Adaptation +Error = VirtualRealityLab.SetAdaptationType(0) +MsgBox ("Human vision mode changed to Local Adaptation") +'Set maximum adaptation luminance to 50 Cd/m² +Error = VirtualRealityLab.SetLocalAdaptationLuminanceMax(50.0) +MsgBox ("Maximum adaptation luminance changed to 50.0 Cd/m²") +'Set adaptation luminance to 100 Cd/m²,but truncated to 50 Cd/m² +Error = VirtualRealityLab.SetLocalAdaptationLuminance(100.0) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setobserverage.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setobserverage.md new file mode 100644 index 0000000000..f4af3b57fb --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/human_vision/labvr_setobserverage.md @@ -0,0 +1,44 @@ +# SetObserverAge + +## Description + +Changes the observer age used for Dynamic Temporal Adaptation and Glare effect. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetObserverAge \(int *iAge*\) + +- *object*: Virtual Reality Lab object. + +- *iAge*: age in years. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Human Vision +Error = VirtualRealityLab.ActivateHumanVision(true) +MsgBox ("Human Vision activated") +'Active glare effect +Error = VirtualRealityLab.ActivateGlare(true) +MsgBox ("Glare activated") +'Change observer age to 51 +Error = VirtualRealityLab.SetObserverAge(51) +MsgBox ("Observer age changed to 51") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/labvr_virtual_reality_lab.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/labvr_virtual_reality_lab.md new file mode 100644 index 0000000000..26b9c27315 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/labvr_virtual_reality_lab.md @@ -0,0 +1,47 @@ +# Virtual Reality Lab + +With Automation in Virtual Reality Lab, you can interact with Speos360 files. + +The installation directory includes a TLB file that describes the Automation interface of the Virtual Reality Lab. + +All examples are given using VB Script language but any other language compatible with Automation can be used. + +## How to call the Virtual Reality Lab + +Before any call to the Virtual Reality Lab methods you should use the following instruction: + +``` +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") + +``` + +This instruction automatically runs the Virtual Reality Lab \(creates an instance of the application\). The other uses of the Virtual Reality Lab should refer to the variable VirtualRealityLab which has been initialized with this instance. + +You could notice that there is no reference to the path where the Virtual Reality Lab is on the disk. As it is an Automation application it has been registered in the Windows registry and Windows understand which application you want to instantiate, with *HDRIViewer.Application*. + +## How to call a method + +To call a method, write *VirtualRealityLab*followed by a "." then by the name of the method and parameters between " and ", each separated by "," and encompassed by "\(\)". For example for opening an Speos360 file, write the following instructions: + +``` +Dim MyVar +MyVar = VirtualRealityLab.OpenFile("C:\InteriorCar.speos360") + +``` + +The *OpenFile*method takes a string as parameter. The variable MyVar holds the result of the method \(success or failure in this case\). + +All the available methods match something existing in the graphic user interface of the Virtual Reality Lab. + +## Syntax description + +All the available methods will be described below using the following syntax: + +\[number\] return\_type Method\_Name\(parameter 1, parameter 2,...\); + +With: + +- \[number\]: ordinal number of the method \(not to be used in most cases\). +- return\_type: type of the return value \(BOOL for Boolean value, short for integer value, double for floating point value, BSTR for string...\). +- Method\_Name: name of the method. +- Parameter n: A keyword for the type of the parameter followed by the parameter name. \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_createimmersiveview.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_createimmersiveview.md new file mode 100644 index 0000000000..345162fb20 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_createimmersiveview.md @@ -0,0 +1,73 @@ +# CreateImmersiveView + +## Description + +Allows you to create an Speos360 Immersive View from a set of .xmp files. Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.CreateImmersiveView\(VARIANT\* *pInputListXMPmap*, VARIANT\* *pInputListRotation*, BSTR *strOutputFileName*, \[optional\] double *dLuminanceMax*\) As Int + +- *object*: Virtual Reality Lab object + +- *pInputListXMPmap*: tab including the absolute filename strings of the .xmp files to create the Immersive View. + + - Index 0: Right + + - Index 1: Left + + - Index 2: Bottom + + - Index 3: Top + + - Index 4: Front + + - Index 5: Back + +- *pInputListRotation*: tab including the rotation angle values \(Int\) of the .xmp files to create the Immersive View, 0, 90, 180 or 270. + + - Index 0: Right + + - Index 1: Left + + - Index 2: Bottom + + - Index 3: Top + + - Index 4: Front + + - Index 5: Back + +- *strOutputFileName*: absolute filename string for the result of the Immersive View Speos360 file. + +- \[optional\] *dLuminanceMax*: maximum luminance value in Cd/m². If the parameter is not filled, the default value is used to create the Immersive View. + + +## Example + +``` +Sub main() + Dim MyFolder As String +MyFolder = "PathWorkSpeace" + Set HDRIViewer = CreateObject("HDRIViewer.Application") + ReDim XmpMap(5) +XmpMap(0) = MyFolder & "NameOfXmpMap0.xmp" +XmpMap(1) = MyFolder & "NameOfXmpMap1.xmp" +XmpMap(2) = MyFolder & "NameOfXmpMap2.xmp" +XmpMap(3) = MyFolder & "NameOfXmpMap3.xmp" +XmpMap(4) = MyFolder & "NameOfXmpMap4.xmp" +XmpMap(5) = MyFolder & "NameOfXmpMap5.xmp" + ReDim Rotation(5) +Rotation(0) = ValueOfRotation° +Rotation(1) = ValueOfRotation° +Rotation(2) = ValueOfRotation° +Rotation(3) = ValueOfRotation° +Rotation(4) = ValueOfRotation° +Rotation(5) = ValueOfRotation° + retval = HDRIViewer.CreateImmersiveView(XmpMap, Rotation, MyFolder & "NameOfOutSpeos360.speos360") 'or \(with the last optional parameter\) retval = HDRIViewer.CreateImmersiveView(XmpMap, Rotation, MyFolder & "NameOfOutSpeos360.speos360", 160) + retval = HDRIViewer.Show(1) + End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_createobserverview.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_createobserverview.md new file mode 100644 index 0000000000..e0ef4690c6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_createobserverview.md @@ -0,0 +1,32 @@ +# CreateObserverView + +## Description + +Creates an observer Speos360 file from a set of XMP files. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.CreateObserverView(VARIANT* pInputListXMP, VARIANT* pInputListHorizontalAngle, VARIANT* pInputListVerticalAngle, BSTR bstrOutputFileName)` as Boolean +- *object*: Virtual Reality Lab +- *pInputListXMP*: array of the XMP absolute filename strings +- *pInputListHorizontalAngle*: array of VARIANT for the horizontal angle of each XMP file +- *pInputListVerticalAngle*: array of VARIANT for the vertical angle of each XMP file +- *bstrOutputFileName*: path and filename of the template \(should end by .speos360\) + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application +Dim XmpFiles +ReDim XmpFiles(2) +XmpFiles(0) = "C:\ObserverView_Stereo_Right_270.xmp" +XmpFiles(1) = "C:\ObserverView_Stereo_Right_274.xmp" +XmpFiles(2) = "C:\ObserverView_Stereo_Right_278.xmp" +vOffsetHorizontalAngles = array(0, 4, 8) +vOffsetVerticalAngles = array(0, 0, 0) +' Creates Observer View result +HDRIViewer.CreateObserverView(XmpFiles, vOffsetHorizontalAngles, vOffsetVerticalAngles, "C:\Example.speos360") +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_operations_on_maps.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_operations_on_maps.md new file mode 100644 index 0000000000..9408d63751 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_operations_on_maps.md @@ -0,0 +1,6 @@ +# Operations on maps + +- [OptisVRMerge](labvr_optisvrmerge.md) +- [OptisVRCombineLayers](labvr_optisvrcombinelayers.md) +- [CreateImmersiveView](labvr_createimmersiveview.md) +- [CreateObserverView](labvr_createobserverview.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_optisvrcombinelayers.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_optisvrcombinelayers.md new file mode 100644 index 0000000000..5891802965 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_optisvrcombinelayers.md @@ -0,0 +1,51 @@ +# OptisVRCombineLayers + +The Speos360 files to combine must have the same resolution. + +## Description + +Retrieves the layers of several maps and combines them in a unique map. + +**Note:** + +If the first map has N layers and the second map has M layers, the result will be a map with N+M layers. + +**Note:** + +A layer can be the light contribution coming from a source or of face. + +Returns a value different than 0 if no error occurred. + +## Syntax + +*object*.OptisVRCombineLayers\(VARIANT\* *pInputListOptisVR*, BSTR *strOutputFileName*\) As Int + +- *object*: Virtual Reality Lab object + +- *pInputListOptisVR*: tab including the absolute filename strings of all the Speos360 files to combine + +- *strOutputFileName*: absolute filename string for the result of the combine operation + + +## Example + +``` +Sub OptisVRCombineLayers() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Definition of the Speos360 files to combine +Dim FileTab +ReDim FileTab(2) +FileTab(0) = "U:\AMT\API VRLab\InteriorCar1.speos360" +FileTab(1) = "U:\AMT\API VRLab\InteriorCar2.speos360" +'Execution of the combine operation +Error = VirtualRealityLab.OptisVRCombineLayers(FileTab, "U:\AMT\API VRLab\InteriorCar_Combined.speos360") +MsgBox ("Files Combined") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_optisvrmerge.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_optisvrmerge.md new file mode 100644 index 0000000000..5ca8c362ff --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/operations_on_maps/labvr_optisvrmerge.md @@ -0,0 +1,45 @@ +# OptisVRMerge + +## Description + +Merges several maps into a new map. + +**Note:** + +![OptisVRMerge equation](../../_assets/labvr_optisvrmerge.png) + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.OptisVRMerge\(VARIANT\* *pInputListOptisVR*, BSTR *strOutputFileName*\) As Int + +- *object*: Virtual Reality Lab object + +- *pInputListOptisVR*: tab including the absolute filename strings of all the Speos360 files to merge + +- *strOutputFileName*: absolute filename string for the result of the merge operation + + +## Example + +``` +Sub OptisVRMerge() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Definition of the Speos360 files to merge +Dim FileTab +ReDim FileTab(2) +FileTab(0) = "U:\AMT\API VRLab\InteriorCar1.speos360" +FileTab(1) = "U:\AMT\API VRLab\InteriorCar2.speos360" +'Execution of the merge operation +Error = VirtualRealityLab.OptisVRMerge(FileTab, "U:\AMT\API VRLab\InteriorCar_Merged.speos360") +MsgBox ("Files Merged") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_activatefiltering.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_activatefiltering.md new file mode 100644 index 0000000000..53771d301f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_activatefiltering.md @@ -0,0 +1,38 @@ +# ActivateFiltering + +## Description + +Activates or deactivates the filtering. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.ActivateFiltering\(bool *bActivated*\) + +- *object* : Virtual Reality Lab object + +- *bActivated*: Boolean activating/deactivating the filtering mode. + + +## Example + +``` +Sub HumanVision() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Activate Filtering +Error = VirtualRealityLab.ActivateFiltering(true) +MsgBox ("Filtering activated") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_other_methods.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_other_methods.md new file mode 100644 index 0000000000..4932bec18c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_other_methods.md @@ -0,0 +1,6 @@ +# Other methods + +- [ActivateFiltering](labvr_activatefiltering.md) +- [SetLuminanceMax](labvr_setluminancemax.md) +- [SetColorSpaceConversion](labvr_setcolorspaceconversion.md) +- [SetFalseColor](labvr_setfalsecolor.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setcolorspaceconversion.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setcolorspaceconversion.md new file mode 100644 index 0000000000..0acac2d09c --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setcolorspaceconversion.md @@ -0,0 +1,47 @@ +# SetColorSpaceConversion + +## Description + +Sets the conversion mode to use between three modes: + +- 0 = Gamut Clipping + +- 1 = Maintain lightness and hue + +- 2 = Maintain hue + + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetColorSpaceConversion\(int *iPosition*\) As Int + +- *object*: Virtual Reality Lab object + +- *iPosition:*defines which mode to use between the three conversion modes. + + +## Example + +``` +Sub SetColorSpaceConversion +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +' + For i = 0 To 3 + Error = VirtualRealityLab.SetColorConversionMode(i); + Next +MsgBox ("Switch between the available color conversion mode") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setfalsecolor.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setfalsecolor.md new file mode 100644 index 0000000000..3a445e0902 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setfalsecolor.md @@ -0,0 +1,63 @@ +# SetFalseColor + +## Description + +Sets the type of color to use between the eight color modes of the viewer: + +- iTypeOfColor 0 = true color + +- iTypeOfColor 1 = Black to white\(color\) + +- iTypeOfColor 2 = White to black\(color\) + +- iTypeOfColor 3 = White to black\(gray scale\) + +- iTypeOfColor 4 = Blue to red\(color\) + +- iTypeOfColor 5 = Red to blue\(color\) + +- iTypeOfColor 6 = White to black \(gray scale\) + +- iTypeOfColor 7 = Black to Color\(Custom\) + +- iTypeOfColor 8 = Black to white\(Custom Color\) + + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetFalseColor\(int *iTypeOfColor*\) As Int + +- *object*: Virtual Reality Lab object + +- *iTypeOfColor:* Defines the definition of the color to use between the 8 modes available from the viewer + + +**Note:** + +With the last two modes, **Black to Color\(Custom\)** and **Black to White\(Custom Color\)**, the custom color used is the color defined in the map. + +## Example + +``` +Sub FalseColor() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +' + For i = 0 To 8 + Error = VirtualRealityLab.SetFalseColor(i); + Next +MsgBox ("Switch between the available display color modes") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setluminancemax.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setluminancemax.md new file mode 100644 index 0000000000..2fe0e6032f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/other_methods/labvr_setluminancemax.md @@ -0,0 +1,41 @@ +# SetLuminanceMax + +## Description + +Set Luminance Max or Adaptive Luminance when Human Vision mode is activated. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object.*SetLuminanceMax\(double *dValue*\) As Int + +- *object*: Virtual Reality Lab object + +- *dValue*: Luminance Max value \(cd/m²\) or Adaptive Luminance value \(cd/m²\) when Human Vision mode is activated + + +## Example + +``` +Sub SetLuminanceMax() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(500) +MsgBox ("First Luminance Set") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Second Luminance Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_getnbsources.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_getnbsources.md new file mode 100644 index 0000000000..012caf5f8a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_getnbsources.md @@ -0,0 +1,37 @@ +# GetNbSources + +## Description + +Returns the number of sources. + +## Syntax + +*object*.GetNbSources\(\) As Int + +- *object*: Virtual Reality Lab object + + +## Example + +``` +Sub GetNbSources() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Evaluate the Number of Sources +Dim SourceNumber +SourceNumber = VirtualRealityLab.GetNbSources() +MsgBox ("Source(s): " & SourceNumber) +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_getsourcenameext.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_getsourcenameext.md new file mode 100644 index 0000000000..32aa12119a --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_getsourcenameext.md @@ -0,0 +1,48 @@ +# GetSourceNameExt + +## Description + +Returns the name of one of the sources. The second argument is an output one. + +Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.GetSourceNameExt(int iSource, VARIANT* ovSourceName)` as Boolean +- *object*: Virtual Reality Lab +- *iSource*: index of the source on the Virtual Lighting Controller starting from 0 +- *ovSourceName*: name of the source + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application") +' Opens observer Speos360 file +HDRIViewer.OpenFile("C:\ObserverView_Stereo.speos360") +' Gets the name of the source #1 +retval = HDRIViewer.GetSourceNameExt(1, SourceName) +Dim SourceName As String +' Prints the name of the source #1 +SourceName = sSourceName(1) +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates HDRIViewer COM server +type = Type.GetTypeFromProgID("HDRIViewer.application") +HDRIViewer = Activator.CreateInstance(type) +#Opens observer Speos360 file +strSpeos360File = "C:\\ObserverView_Stereo.speos360" +HDRIViewer.OpenFile(strSpeos360File) +#Gets the name of the source #1 +sSourceName = clr.Reference[System.Object]() #Creates a default pointer +retval = HDRIViewer.GetSourceNameExt(1, sSourceName) +# Prints the name of the source number 3 +sourceName = sSourceName.Value +print sourceName[0] +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcename.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcename.md new file mode 100644 index 0000000000..69710ae66f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcename.md @@ -0,0 +1,39 @@ +# SetSourceName + +## Description + +Renames one of the sources. Returns TRUE if the call has succeeded, FALSE otherwise. + +## Syntax + +- `object.SetSourceName(int iSource, BSTR bstrSourceName)` as Boolean +- *object*: Virtual Reality Lab +- *iSource*: index of the source in Virtual Lighting Controller \(starting from 0\) +- *bstrSourceName*: the new name of the source + +## VB script example + +```VB +' Creates HDRIViewer COM server +set HDRIViewer = CreateObject("HDRIViewer.application") +' Opens observer Speos360 file +HDRIViewer.OpenFile("C:\ObserverView_Stereo.speos360") +' Sets the name of the source number 2 +HDRIViewer.SetSourceName(2, "New name of layer #2") +``` + +## IronPython example + +```ironpython +from System import Type, Activator +#Creates HDRIViewer COM server +type = Type.GetTypeFromProgID("HDRIViewer.application") +HDRIViewer = Activator.CreateInstance(type) +#Opens observer Speos360 file +strSpeos360File = "C:\\ObserverView_Stereo.speos360" +HDRIViewer.OpenFile(strSpeos360File) +#Sets the name of the third source +result = HDRIViewer.SetSourceName(2, “New name of layer #2”) +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcepowerbyid.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcepowerbyid.md new file mode 100644 index 0000000000..4aeec83164 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcepowerbyid.md @@ -0,0 +1,43 @@ +# SetSourcePowerById + +## Description + +Sets the power of a source using its index. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetSourcePowerById\(int *uiIDSource*, double *dPowerLumen*\) As Int + +- *object*: Virtual Reality Lab object + +- *uiIDSource*: index of the source on the Virtual Lighting Controller starting from 0 + +- *dPowerLumen*: power of the source value \(lm\) + + +## Example + +``` +Sub SetSourcePowerById() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Before Source Power Set") +'Set the Power of the first Source to 100lm +Error = VirtualRealityLab.SetSourcePowerById(0, 100) +MsgBox ("After Source Power Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcepowerbyname.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcepowerbyname.md new file mode 100644 index 0000000000..c2405eea4f --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourcepowerbyname.md @@ -0,0 +1,43 @@ +# SetSourcePowerByName + +## Description + +Sets the power of a source using its name. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetSourcePowerByName\(BSTR *strLayerName*, double *dPowerLumen*\) As Int + +- *object*: Virtual Reality Lab object + +- *strLayerName*: string for the name of the source from the Virtual Lighting Controller + +- *dPowerLumen*: power of the source value \(lm\) + + +## Example + +``` +Sub SetSourcePowerByName() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Before Source Power Set") +'Set the Power of the source called "RedGuide" to 100lm +Error = VirtualRealityLab.SetSourcePowerByName("RedGuide", 100) +MsgBox ("After Source Power Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourceratiobyid.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourceratiobyid.md new file mode 100644 index 0000000000..8d70a96a69 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourceratiobyid.md @@ -0,0 +1,43 @@ +# SetSourceRatioById + +## Description + +Sets the power of a source by defining a ratio and using its index. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetSourceRatioById\(int *uiIDSource*, double *dRatio*\) As Int + +- *object*: Virtual Reality Lab object + +- *uiIDSource*: index of the source on the Virtual Lighting Controller starting from 0 + +- *dRatio*: ratio defining the power of the source \(%\) + + +## Example + +``` +Sub SetSourceRatioById() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Before Source Ratio Set") +'Set the Power of the first Source to half its initial power +Error = VirtualRealityLab.SetSourceRatioById(0, 50) +MsgBox ("After Source Ratio Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourceratiobyname.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourceratiobyname.md new file mode 100644 index 0000000000..717c8aacd3 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_setsourceratiobyname.md @@ -0,0 +1,43 @@ +# SetSourceRatioByName + +## Description + +Sets the power of a source by defining a ratio and using its name. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetSourceRatioByName\(BSTR *strLayerName*, double *dRatio*\) As Int + +- *object*: Virtual Reality Lab object + +- *strLayerName*: string for the name of the source from the Virtual Lighting Controller + +- *dRatio*: ratio defining the power of the source \(%\) + + +## Example + +``` +Sub SetSourceRatioByName() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +MsgBox ("Before Source Ratio Set") +'Set the Power of the Source "RedGuide" to half its initial power +Error = VirtualRealityLab.SetSourceRatioByName("RedGuide", 50) +MsgBox ("After Source Ratio Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_sources.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_sources.md new file mode 100644 index 0000000000..4b21855c05 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/sources/labvr_sources.md @@ -0,0 +1,9 @@ +# Sources + +- [GetSourceNameExt](labvr_getsourcenameext.md) +- [SetSourceName](labvr_setsourcename.md) +- [GetNbSources](labvr_getnbsources.md) +- [SetSourcePowerById](labvr_setsourcepowerbyid.md) +- [SetSourcePowerByName](labvr_setsourcepowerbyname.md) +- [SetSourceRatioById](labvr_setsourceratiobyid.md) +- [SetSourceRatioByName](labvr_setsourceratiobyname.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setlefteye.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setlefteye.md new file mode 100644 index 0000000000..eb3a4e8fb6 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setlefteye.md @@ -0,0 +1,38 @@ +# SetLeftEye + +## Description + +Sets the visualization mode in left eye alone. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetLeftEye\(\) As Int + +- *object*: Virtual Reality Lab object + + +## Example + +``` +Sub SetLeftEye() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Change Vizualisation Mode +Error = VirtualRealityLab.SetLeftEye() +MsgBox ("Left Eye Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setrighteye.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setrighteye.md new file mode 100644 index 0000000000..471c30bef2 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setrighteye.md @@ -0,0 +1,38 @@ +# SetRightEye + +## Description + +Sets the visualization mode in right eye alone. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetRightEye\(\) As Int + +- *object*: Virtual Reality Lab object + + +## Example + +``` +Sub SetRightEye() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Change Vizualisation Mode +Error = VirtualRealityLab.SetRightEye() +MsgBox ("Right Eye Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setstereoeyes.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setstereoeyes.md new file mode 100644 index 0000000000..94b2e235ba --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_setstereoeyes.md @@ -0,0 +1,38 @@ +# SetStereoEyes + +## Description + +Sets the visualization mode in stereo. + +Returns 1 if the call has succeeded, 0 otherwise. + +## Syntax + +*object*.SetStereoEyes\(\) As Int + +- *object*: Virtual Reality Lab object + + +## Example + +``` +Sub SetStereoEyes() +'Error Management +Dim Error As Integer +'Declare VRLab +Dim VirtualRealityLab As Object +Set VirtualRealityLab = CreateObject("HDRIViewer.Application") +'Show VRLab +Error = VirtualRealityLab.Show(True) +'Open File +Error = VirtualRealityLab.OpenFile("U:\AMT\API VRLab\InteriorCar.speos360") +'Set Luminance Max +Error = VirtualRealityLab.SetLuminanceMax(100) +'Change Vizualisation Mode +Error = VirtualRealityLab.SetStereoEyes() +MsgBox ("Stereo Eyes Set") +End Sub + +``` + + diff --git a/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_visualization_mode.md b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_visualization_mode.md new file mode 100644 index 0000000000..66f2846ff5 --- /dev/null +++ b/2025R1_Test/speos_labs/articles/virtual_reality_lab/visualization_mode/labvr_visualization_mode.md @@ -0,0 +1,5 @@ +# Visualization mode + +- [SetLeftEye](labvr_setlefteye.md) +- [SetRightEye](labvr_setrighteye.md) +- [SetStereoEyes](labvr_setstereoeyes.md) \ No newline at end of file diff --git a/2025R1_Test/speos_labs/docfx.json b/2025R1_Test/speos_labs/docfx.json new file mode 100644 index 0000000000..c9670d4726 --- /dev/null +++ b/2025R1_Test/speos_labs/docfx.json @@ -0,0 +1,66 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "src/**.csproj" + ] + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "**/*.png", + "**/*.jpg", + "**/*.gif" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default" + ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false + } +} \ No newline at end of file diff --git a/2025R1_Test/speos_labs/index.md b/2025R1_Test/speos_labs/index.md new file mode 100644 index 0000000000..3ae2506361 --- /dev/null +++ b/2025R1_Test/speos_labs/index.md @@ -0,0 +1,4 @@ +# This is the **HOMEPAGE**. +Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. +## Quick Start Notes: +1. Add images to the *images* folder if the file is referencing an image. diff --git a/2025R1_Test/speos_labs/styles/Google/AMPM.yml b/2025R1_Test/speos_labs/styles/Google/AMPM.yml new file mode 100644 index 0000000000..fbdc6e4f84 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: 'https://developers.google.com/style/word-list' +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/2025R1_Test/speos_labs/styles/Google/Acronyms.yml b/2025R1_Test/speos_labs/styles/Google/Acronyms.yml new file mode 100644 index 0000000000..f41af0189b --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/2025R1_Test/speos_labs/styles/Google/Colons.yml b/2025R1_Test/speos_labs/styles/Google/Colons.yml new file mode 100644 index 0000000000..99363fbd46 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Colons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should be in lowercase." +link: 'https://developers.google.com/style/colons' +nonword: true +level: warning +scope: sentence +tokens: + - ':\s[A-Z]' diff --git a/2025R1_Test/speos_labs/styles/Google/Contractions.yml b/2025R1_Test/speos_labs/styles/Google/Contractions.yml new file mode 100644 index 0000000000..4f6fd5d489 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Contractions.yml @@ -0,0 +1,30 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/contractions' +level: suggestion +ignorecase: true +action: + name: replace +swap: + are not: aren't + cannot: can't + could not: couldn't + did not: didn't + do not: don't + does not: doesn't + has not: hasn't + have not: haven't + how is: how's + is not: isn't + it is: it's + should not: shouldn't + that is: that's + they are: they're + was not: wasn't + we are: we're + we have: we've + were not: weren't + what is: what's + when is: when's + where is: where's + will not: won't diff --git a/2025R1_Test/speos_labs/styles/Google/DateFormat.yml b/2025R1_Test/speos_labs/styles/Google/DateFormat.yml new file mode 100644 index 0000000000..e9d227fa13 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/DateFormat.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/2025R1_Test/speos_labs/styles/Google/Ellipses.yml b/2025R1_Test/speos_labs/styles/Google/Ellipses.yml new file mode 100644 index 0000000000..1e070517bf --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: 'https://developers.google.com/style/ellipses' +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/2025R1_Test/speos_labs/styles/Google/EmDash.yml b/2025R1_Test/speos_labs/styles/Google/EmDash.yml new file mode 100644 index 0000000000..1befe72aa8 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/EmDash.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't put a space before or after a dash." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - remove + - ' ' +tokens: + - '\s[—–]\s' diff --git a/2025R1_Test/speos_labs/styles/Google/EnDash.yml b/2025R1_Test/speos_labs/styles/Google/EnDash.yml new file mode 100644 index 0000000000..b314dc4e98 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/EnDash.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use an em dash ('—') instead of '–'." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: error +action: + name: edit + params: + - replace + - '-' + - '—' +tokens: + - '–' diff --git a/2025R1_Test/speos_labs/styles/Google/Exclamation.yml b/2025R1_Test/speos_labs/styles/Google/Exclamation.yml new file mode 100644 index 0000000000..eea5fd24bd --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Exclamation.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use exclamation points in text." +link: 'https://developers.google.com/style/exclamation-points' +nonword: true +level: error +action: + name: remove +tokens: + - '\w+!(?:\s|$)' diff --git a/2025R1_Test/speos_labs/styles/Google/FirstPerson.yml b/2025R1_Test/speos_labs/styles/Google/FirstPerson.yml new file mode 100644 index 0000000000..0b7b8828ca --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/FirstPerson.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Avoid first-person pronouns such as '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/2025R1_Test/speos_labs/styles/Google/Gender.yml b/2025R1_Test/speos_labs/styles/Google/Gender.yml new file mode 100644 index 0000000000..c8486181d6 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Gender.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use '%s' as a gender-neutral pronoun." +link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' +level: error +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he diff --git a/2025R1_Test/speos_labs/styles/Google/GenderBias.yml b/2025R1_Test/speos_labs/styles/Google/GenderBias.yml new file mode 100644 index 0000000000..9e70190863 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/GenderBias.yml @@ -0,0 +1,47 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: 'https://developers.google.com/style/inclusive-documentation' +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/2025R1_Test/speos_labs/styles/Google/HeadingPunctuation.yml b/2025R1_Test/speos_labs/styles/Google/HeadingPunctuation.yml new file mode 100644 index 0000000000..b538be5b42 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a period at the end of a heading." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - remove + - '.' +tokens: + - '[a-z0-9][.]\s*$' diff --git a/2025R1_Test/speos_labs/styles/Google/Headings.yml b/2025R1_Test/speos_labs/styles/Google/Headings.yml new file mode 100644 index 0000000000..e34d001b77 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Headings.yml @@ -0,0 +1,28 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" +level: warning +scope: heading +match: $sentence +indicators: + - ":" +exceptions: + - Azure + - CLI + - Cosmos + - Docker + - Emmet + - gRPC + - I + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - REPL + - Studio + - TypeScript + - URLs + - Visual + - VS + - Windows diff --git a/2025R1_Test/speos_labs/styles/Google/Latin.yml b/2025R1_Test/speos_labs/styles/Google/Latin.yml new file mode 100644 index 0000000000..ca03b9154b --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Latin.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)(?=[\s,;])': for example + '\b(?:ie|i\.e\.)(?=[\s,;])': that is diff --git a/2025R1_Test/speos_labs/styles/Google/LyHyphens.yml b/2025R1_Test/speos_labs/styles/Google/LyHyphens.yml new file mode 100644 index 0000000000..ac8f557a4a --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/LyHyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: 'https://developers.google.com/style/hyphens' +level: error +ignorecase: false +nonword: true +action: + name: edit + params: + - replace + - '-' + - ' ' +tokens: + - '\s[^\s-]+ly-' diff --git a/2025R1_Test/speos_labs/styles/Google/OptionalPlurals.yml b/2025R1_Test/speos_labs/styles/Google/OptionalPlurals.yml new file mode 100644 index 0000000000..f858ea6fee --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/OptionalPlurals.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'." +link: 'https://developers.google.com/style/plurals-parentheses' +level: error +nonword: true +action: + name: edit + params: + - remove + - '(s)' +tokens: + - '\b\w+\(s\)' diff --git a/2025R1_Test/speos_labs/styles/Google/Ordinal.yml b/2025R1_Test/speos_labs/styles/Google/Ordinal.yml new file mode 100644 index 0000000000..d1ac7d27e8 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Ordinal.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Spell out all ordinal numbers ('%s') in text." +link: 'https://developers.google.com/style/numbers' +level: error +nonword: true +tokens: + - \d+(?:st|nd|rd|th) diff --git a/2025R1_Test/speos_labs/styles/Google/OxfordComma.yml b/2025R1_Test/speos_labs/styles/Google/OxfordComma.yml new file mode 100644 index 0000000000..b9ba21ebb2 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: 'https://developers.google.com/style/commas' +scope: sentence +level: warning +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/2025R1_Test/speos_labs/styles/Google/Parens.yml b/2025R1_Test/speos_labs/styles/Google/Parens.yml new file mode 100644 index 0000000000..3b8711d0c8 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Parens.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use parentheses judiciously." +link: 'https://developers.google.com/style/parentheses' +nonword: true +level: suggestion +tokens: + - '\(.+\)' diff --git a/2025R1_Test/speos_labs/styles/Google/Passive.yml b/2025R1_Test/speos_labs/styles/Google/Passive.yml new file mode 100644 index 0000000000..3265890e52 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Passive.yml @@ -0,0 +1,184 @@ +extends: existence +link: 'https://developers.google.com/style/voice' +message: "In general, use active voice instead of passive voice ('%s')." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/2025R1_Test/speos_labs/styles/Google/Periods.yml b/2025R1_Test/speos_labs/styles/Google/Periods.yml new file mode 100644 index 0000000000..d24a6a6c03 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Periods.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use periods with acronyms or initialisms such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +level: error +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' diff --git a/2025R1_Test/speos_labs/styles/Google/Quotes.yml b/2025R1_Test/speos_labs/styles/Google/Quotes.yml new file mode 100644 index 0000000000..3cb6f1abd1 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Commas and periods go inside quotation marks." +link: 'https://developers.google.com/style/quotation-marks' +level: error +nonword: true +tokens: + - '"[^"]+"[.,?]' diff --git a/2025R1_Test/speos_labs/styles/Google/Ranges.yml b/2025R1_Test/speos_labs/styles/Google/Ranges.yml new file mode 100644 index 0000000000..3ec045e777 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Ranges.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add words such as 'from' or 'between' to describe a range of numbers." +link: 'https://developers.google.com/style/hyphens' +nonword: true +level: warning +tokens: + - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/2025R1_Test/speos_labs/styles/Google/Semicolons.yml b/2025R1_Test/speos_labs/styles/Google/Semicolons.yml new file mode 100644 index 0000000000..bb8b85b420 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Semicolons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use semicolons judiciously." +link: 'https://developers.google.com/style/semicolons' +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/2025R1_Test/speos_labs/styles/Google/Slang.yml b/2025R1_Test/speos_labs/styles/Google/Slang.yml new file mode 100644 index 0000000000..63f4c248a8 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Slang.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Don't use internet slang abbreviations such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +tokens: + - 'tl;dr' + - ymmv + - rtfm + - imo + - fwiw diff --git a/2025R1_Test/speos_labs/styles/Google/Spacing.yml b/2025R1_Test/speos_labs/styles/Google/Spacing.yml new file mode 100644 index 0000000000..66e45a6b72 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Spacing.yml @@ -0,0 +1,10 @@ +extends: existence +message: "'%s' should have one space." +link: 'https://developers.google.com/style/sentence-spacing' +level: error +nonword: true +action: + name: remove +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/2025R1_Test/speos_labs/styles/Google/Spelling.yml b/2025R1_Test/speos_labs/styles/Google/Spelling.yml new file mode 100644 index 0000000000..527ac07d31 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Spelling.yml @@ -0,0 +1,10 @@ +extends: existence +message: "In general, use American spelling instead of '%s'." +link: 'https://developers.google.com/style/spelling' +ignorecase: true +level: warning +tokens: + - '(?:\w+)nised?' + - 'colour' + - 'labour' + - 'centre' diff --git a/2025R1_Test/speos_labs/styles/Google/Units.yml b/2025R1_Test/speos_labs/styles/Google/Units.yml new file mode 100644 index 0000000000..53522ab2de --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Units.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Put a nonbreaking space between the number and the unit in '%s'." +link: "https://developers.google.com/style/units-of-measure" +nonword: true +level: error +tokens: + - \b\d+(?:B|kB|MB|GB|TB) + - \b\d+(?:ns|ms|s|min|h|d) diff --git a/2025R1_Test/speos_labs/styles/Google/We.yml b/2025R1_Test/speos_labs/styles/Google/We.yml new file mode 100644 index 0000000000..c7ac7d3622 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/2025R1_Test/speos_labs/styles/Google/Will.yml b/2025R1_Test/speos_labs/styles/Google/Will.yml new file mode 100644 index 0000000000..128a918362 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/Will.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Avoid using '%s'." +link: 'https://developers.google.com/style/tense' +ignorecase: true +level: warning +tokens: + - will diff --git a/2025R1_Test/speos_labs/styles/Google/WordList.yml b/2025R1_Test/speos_labs/styles/Google/WordList.yml new file mode 100644 index 0000000000..0d675f2372 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/WordList.yml @@ -0,0 +1,81 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: "https://developers.google.com/style/word-list" +level: warning +ignorecase: false +action: + name: replace +swap: + "(?:API Console|dev|developer) key": API key + "(?:cell ?phone|smart ?phone)": phone|mobile phone + "(?:dev|developer|APIs) console": API console + "(?:e-mail|Email|E-mail)": email + "(?:file ?path|path ?name)": path + "(?:kill|terminate|abort)": stop|exit|cancel|end + "(?:OAuth ?2|Oauth)": OAuth 2.0 + "(?:ok|Okay)": OK|okay + "(?:WiFi|wifi)": Wi-Fi + '[\.]+apk': APK + '3\-D': 3D + 'Google (?:I\-O|IO)': Google I/O + "tap (?:&|and) hold": touch & hold + "un(?:check|select)": clear + above: preceding + account name: username + action bar: app bar + admin: administrator + Ajax: AJAX + a\.k\.a|aka: or|also known as + Android device: Android-powered device + android: Android + API explorer: APIs Explorer + application: app + approx\.: approximately + authN: authentication + authZ: authorization + autoupdate: automatically update + cellular data: mobile data + cellular network: mobile network + chapter: documents|pages|sections + check box: checkbox + check: select + CLI: command-line tool + click on: click|click in + Cloud: Google Cloud Platform|GCP + Container Engine: Kubernetes Engine + content type: media type + curated roles: predefined roles + data are: data is + Developers Console: Google API Console|API Console + disabled?: turn off|off + ephemeral IP address: ephemeral external IP address + fewer data: less data + file name: filename + firewalls: firewall rules + functionality: capability|feature + Google account: Google Account + Google accounts: Google Accounts + Googling: search with Google + grayed-out: unavailable + HTTPs: HTTPS + in order to: to + ingest: import|load + k8s: Kubernetes + long press: touch & hold + network IP address: internal IP address + omnibox: address bar + open-source: open source + overview screen: recents screen + regex: regular expression + SHA1: SHA-1|HAS-SHA1 + sign into: sign in to + sign-?on: single sign-on + static IP address: static external IP address + stylesheet: style sheet + synch: sync + tablename: table name + tablet: device + touch: tap + url: URL + vs\.: versus + World Wide Web: web diff --git a/2025R1_Test/speos_labs/styles/Google/meta.json b/2025R1_Test/speos_labs/styles/Google/meta.json new file mode 100644 index 0000000000..a5da2a8480 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/Google/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Google/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/2025R1_Test/speos_labs/styles/Google/vocab.txt b/2025R1_Test/speos_labs/styles/Google/vocab.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/2025R1_Test/speos_labs/styles/config/vocabularies/ansys/accept.txt b/2025R1_Test/speos_labs/styles/config/vocabularies/ansys/accept.txt new file mode 100644 index 0000000000..3179609ed4 --- /dev/null +++ b/2025R1_Test/speos_labs/styles/config/vocabularies/ansys/accept.txt @@ -0,0 +1,12 @@ +[Aa]nsys +Speos +dValue +APIs +boolean +Enum +SpeosSim +SpeosDes +SpeosAsm +CAD +bool +Eulumdat \ No newline at end of file diff --git a/2025R1_Test/speos_labs/toc.yml b/2025R1_Test/speos_labs/toc.yml new file mode 100644 index 0000000000..59f8010471 --- /dev/null +++ b/2025R1_Test/speos_labs/toc.yml @@ -0,0 +1,5 @@ +- name: Articles + href: articles/ +- name: Api Documentation + href: api/ + homepage: api/index.md