## On this page

  

 

 # SensorVRImmersiveBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for an immersive sensor. [More...](#details)

Inheritance diagram for SensorVRImmersiveBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_sensor_v_r_immersive_builder.png)



## <a id="properties" name="properties"></a>Properties

 [ActivateAutomaticFraming](#ad7081cc6608f7bd5bd8b70a710e91dee) = property(fget = \_\_GetActivateAutomaticFraming, fset = \_\_SetActivateAutomaticFraming) Gets or sets the automatic framing property.   
  [AxisSystem](#a4c4b8fa4fecce1d2737f605f77e7320a) = property(fget = \_\_GetAxisSystem) Gets the axis system.   
  [Back](#a8fee0efaea2d344fc8b612548d324a0e) = property(fget = \_\_GetBack, fset = \_\_SetBack) Gets or sets the back face property.   
  [Bottom](#a901b2695b45f01b091a2a99fb88c3858) = property(fget = \_\_GetBottom, fset = \_\_SetBottom) Gets or sets the bottom face property.   
  [FramingFace](#adfe00c3ba700d265b9d5139546e3f900) = property(fget = \_\_GetFramingFace, fset = \_\_SetFramingFace) Gets or sets the framing face.   
  [Front](#a12caba25d0acd6b9171152bbd6e782a0) = property(fget = \_\_GetFront, fset = \_\_SetFront) Gets or sets the front face property.   
  [IntegrationAngle](#a188b37c609ded1240ea089afdd585e2f) = property(fget = \_\_GetIntegrationAngle, fset = \_\_SetIntegrationAngle) Gets or sets the integration angle.   
  [InterocularDistance](#af00623640b0aed657b4bc1ffb9304670) = property(fget = \_\_GetInterocularDistance, fset = \_\_SetInterocularDistance) Gets or set the interocular distance.   
  [Layer](#a9a8118be7780e95363d631cbca7e7800) = property(fget = \_\_GetLayer, fset = \_\_SetLayer) Gets or sets the layer mode.   
  [Left](#aa149c1d1da2ae1c94f1ae91f4919625a) = property(fget = \_\_GetLeft, fset = \_\_SetLeft) Gets or sets the left face property.   
  [PreviewSize](#aa10cc10c2acf6c3d1ca98afff67b96f1) = property(fget = \_\_GetPreviewSize, fset = \_\_SetPreviewSize) Gets or sets the preview arrows size.   
  [Resolution](#a3c1fc1369ee351f25804c8cde5e85ac3) = property(fget = \_\_GetResolution) Gets the resolution.   
  [Right](#a338f1941aaeb45ceefaa84416d2aaddb) = property(fget = \_\_GetRight, fset = \_\_SetRight) Gets or sets the right face property.   
  [Sampling](#a68753490b7d14ebe7a4aa8ca4b8a22c4) = property(fget = \_\_GetSampling, fset = \_\_SetSampling) Gets or sets the sampling.   
  [Stereo](#a0efd4e24b2435aff80b5a5bac9b6cff1) = property(fget = \_\_GetStereo, fset = \_\_SetStereo) gets or sets the stereo property.   
  [Top](#a7adef56c49bff81146683b744f1eaeec) = property(fget = \_\_GetTop, fset = \_\_SetTop) Gets or sets the top face property.   
  [WavelengthEnd](#a46bde9dee090ea55c3b34fdfeedd8c4c) = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd) Gets or sets the higher value of the wavelength range to be considered by the sensor.   
  [WavelengthResolution](#ae7d4742766f2a2e3468a5a9422e7920c) = property(fget = \_\_GetWavelengthResolution, fset = \_\_SetWavelengthResolution) Gets or sets the Wavelength resolution.   
  [WavelengthSampling](#ac0504254907d817707b6771948e9affe) = property(fget = \_\_GetWavelengthSampling, fset = \_\_SetWavelengthSampling) Gets or sets the wavelength sampling.   
  [WavelengthStart](#a437eeee4ad26212fa85c30cfbf5b09c8) = property(fget = \_\_GetWavelengthStart, fset = \_\_SetWavelengthStart) Gets or sets the lower value of the wavelength range to be considered by the sensor.   
 ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Feature](class_speos_n_x_1_1_feature_builder.xhtml#a94ea57aab7fe0356cbfbd048b1ad971e) = property(fget = \_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
  [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a0b7259da2de11c688aa435d1f0509134) = property(fget = \_\_GetFullName) Gets the full name of the feature being edited.   
  [Name](class_speos_n_x_1_1_feature_builder.xhtml#aa5998168cabfb2b2e41151349077812c) = property(fget = \_\_GetName, fset = \_\_SetName) Gets or sets the name of the feature being edited.   
  [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a99e8764720550e4ed0eba629a625b2e3) = property(fget = \_\_GetNameWithContext) Gets the name with context of the feature being edited.   
  [Status](class_speos_n_x_1_1_feature_builder.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b) = property(fget = \_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a2b74e1b440341a82332053432b52b42c) (self) Commits any edits that have been applied to the builder.   
  **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 <a id="details" name="details"></a>## Detailed Description

Represents the builder for an immersive sensor.

The immersive sensor builder is used to create and edit immersive sensor features.

To create a new instance of this class, use <a class="el" href="">FeatureCollection::CreateSensorVRImmersiveBuilder</a>



## Property Documentation

<a id="ad7081cc6608f7bd5bd8b70a710e91dee" name="ad7081cc6608f7bd5bd8b70a710e91dee"></a>## [◆ ](#ad7081cc6608f7bd5bd8b70a710e91dee)ActivateAutomaticFraming

 ActivateAutomaticFraming = property(fget = \_\_GetActivateAutomaticFraming, fset = \_\_SetActivateAutomaticFraming)  static 

Gets or sets the automatic framing property.

True: Activates automatic framing.  
 False: Deactivates automatic framing.

**Value type**: Boolean.

The default value is False.





<a id="a4c4b8fa4fecce1d2737f605f77e7320a" name="a4c4b8fa4fecce1d2737f605f77e7320a"></a>## [◆ ](#a4c4b8fa4fecce1d2737f605f77e7320a)AxisSystem

 [AxisSystem](class_speos_n_x_1_1_axis_system.xhtml) = property(fget = \_\_GetAxisSystem)  static 

Gets the axis system.

**Value type**: AxisSytem object.





<a id="a8fee0efaea2d344fc8b612548d324a0e" name="a8fee0efaea2d344fc8b612548d324a0e"></a>## [◆ ](#a8fee0efaea2d344fc8b612548d324a0e)Back

 Back = property(fget = \_\_GetBack, fset = \_\_SetBack)  static 

Gets or sets the back face property.

True: Enables back face in the simulation.  
 False: Disables back face in the simulation.

**Value type**: Boolean.

The default value is True.





<a id="a901b2695b45f01b091a2a99fb88c3858" name="a901b2695b45f01b091a2a99fb88c3858"></a>## [◆ ](#a901b2695b45f01b091a2a99fb88c3858)Bottom

 Bottom = property(fget = \_\_GetBottom, fset = \_\_SetBottom)  static 

Gets or sets the bottom face property.

True: Enables bottom face in the simulation.  
 False: Disables bottom face in the simulation.

**Value type**: Boolean.

The default value is True.





<a id="adfe00c3ba700d265b9d5139546e3f900" name="adfe00c3ba700d265b9d5139546e3f900"></a>## [◆ ](#adfe00c3ba700d265b9d5139546e3f900)FramingFace

 FramingFace = property(fget = \_\_GetFramingFace, fset = \_\_SetFramingFace)  static 

Gets or sets the framing face.

**Prerequisite**: The EnableFraming property must be True.  
 Positions the camera, in the 3D view, according to the faces selected from the choice list.

The values are:  
 0 - FRONT.  
 1 - BACK.  
 2 - TOP.  
 3 - BOTTOM.  
 4 - LEFT.  
 5 - RIGHT.

**Value type**: Integer.

The default value is 0.





<a id="a12caba25d0acd6b9171152bbd6e782a0" name="a12caba25d0acd6b9171152bbd6e782a0"></a>## [◆ ](#a12caba25d0acd6b9171152bbd6e782a0)Front

 Front = property(fget = \_\_GetFront, fset = \_\_SetFront)  static 

Gets or sets the front face property.

True: Enables front face in the simulation.  
 False: Disables front face in the simulation.

**Value type**: Boolean.

The default value is True.





<a id="a188b37c609ded1240ea089afdd585e2f" name="a188b37c609ded1240ea089afdd585e2f"></a>## [◆ ](#a188b37c609ded1240ea089afdd585e2f)IntegrationAngle

 IntegrationAngle = property(fget = \_\_GetIntegrationAngle, fset = \_\_SetIntegrationAngle)  static 

Gets or sets the integration angle.

**Value type**: Double (in degrees).

The default value is 5.0 degrees.





<a id="af00623640b0aed657b4bc1ffb9304670" name="af00623640b0aed657b4bc1ffb9304670"></a>## [◆ ](#af00623640b0aed657b4bc1ffb9304670)InterocularDistance

 InterocularDistance = property(fget = \_\_GetInterocularDistance, fset = \_\_SetInterocularDistance)  static 

Gets or set the interocular distance.

**Prerequisite**: The Stereo property must be True.

**Value type**: Double (in mm).  
**Range**: The value must be superior to 0.0.

The default value is 65.0 mm.





<a id="a9a8118be7780e95363d631cbca7e7800" name="a9a8118be7780e95363d631cbca7e7800"></a>## [◆ ](#a9a8118be7780e95363d631cbca7e7800)Layer

 Layer = property(fget = \_\_GetLayer, fset = \_\_SetLayer)  static 

Gets or sets the layer mode.

The values are:  
 0 - None, the simulation generates a Speos360 file with one layer for all sources.  
 1 - Source, the result includes one layer per active source.

**Value type**: Integer.

The default value is 0.





<a id="aa149c1d1da2ae1c94f1ae91f4919625a" name="aa149c1d1da2ae1c94f1ae91f4919625a"></a>## [◆ ](#aa149c1d1da2ae1c94f1ae91f4919625a)Left

 Left = property(fget = \_\_GetLeft, fset = \_\_SetLeft)  static 

Gets or sets the left face property.

True: Enables left face in the simulation.  
 False: Disables left face in the simulation.

**Value type**: Boolean.

The default value is True.





<a id="aa10cc10c2acf6c3d1ca98afff67b96f1" name="aa10cc10c2acf6c3d1ca98afff67b96f1"></a>## [◆ ](#aa10cc10c2acf6c3d1ca98afff67b96f1)PreviewSize

 PreviewSize = property(fget = \_\_GetPreviewSize, fset = \_\_SetPreviewSize)  static 

Gets or sets the preview arrows size.

**Value type**: Double (in nm).

The default value is 500.0 nm.





<a id="a3c1fc1369ee351f25804c8cde5e85ac3" name="a3c1fc1369ee351f25804c8cde5e85ac3"></a>## [◆ ](#a3c1fc1369ee351f25804c8cde5e85ac3)Resolution

 Resolution = property(fget = \_\_GetResolution)  static 

Gets the resolution.

**Value type**: Double.





<a id="a338f1941aaeb45ceefaa84416d2aaddb" name="a338f1941aaeb45ceefaa84416d2aaddb"></a>## [◆ ](#a338f1941aaeb45ceefaa84416d2aaddb)Right

 Right = property(fget = \_\_GetRight, fset = \_\_SetRight)  static 

Gets or sets the right face property.

True: Enables right face in the simulation.  
 False: Disables right face in the simulation.

**Value type**: Boolean.

The default value is True.





<a id="a68753490b7d14ebe7a4aa8ca4b8a22c4" name="a68753490b7d14ebe7a4aa8ca4b8a22c4"></a>## [◆ ](#a68753490b7d14ebe7a4aa8ca4b8a22c4)Sampling

 Sampling = property(fget = \_\_GetSampling, fset = \_\_SetSampling)  static 

Gets or sets the sampling.

Edits the value to compute the resolution of the result.

**Value type**: Integer.  
**Range**: The value must be superior or equal to 0.

The default value is 600.





<a id="a0efd4e24b2435aff80b5a5bac9b6cff1" name="a0efd4e24b2435aff80b5a5bac9b6cff1"></a>## [◆ ](#a0efd4e24b2435aff80b5a5bac9b6cff1)Stereo

 Stereo = property(fget = \_\_GetStereo, fset = \_\_SetStereo)  static 

gets or sets the stereo property.

When you define a stereo sensor, make sure that the Front direction is horizontal, the Top direction is vertical, and the Central resolution matches the intended 3D display.

True: Enables stereo.  
 False: Disables stereo.

**Value type**: Boolean.

The default value is False.





<a id="a7adef56c49bff81146683b744f1eaeec" name="a7adef56c49bff81146683b744f1eaeec"></a>## [◆ ](#a7adef56c49bff81146683b744f1eaeec)Top

 Top = property(fget = \_\_GetTop, fset = \_\_SetTop)  static 

Gets or sets the top face property.

True: Enables top face in the simulation.  
 False: Disables top face in the simulation.

**Value type**: Boolean.

The default value is True.





<a id="a46bde9dee090ea55c3b34fdfeedd8c4c" name="a46bde9dee090ea55c3b34fdfeedd8c4c"></a>## [◆ ](#a46bde9dee090ea55c3b34fdfeedd8c4c)WavelengthEnd

 WavelengthEnd = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd)  static 

Gets or sets the higher value of the wavelength range to be considered by the sensor.

The sensor does not take into account wavelengths beyond the borders that you define.

**Value type**: Double (in nm).

The default value is 700.0 nm.





<a id="ae7d4742766f2a2e3468a5a9422e7920c" name="ae7d4742766f2a2e3468a5a9422e7920c"></a>## [◆ ](#ae7d4742766f2a2e3468a5a9422e7920c)WavelengthResolution

 WavelengthResolution = property(fget = \_\_GetWavelengthResolution, fset = \_\_SetWavelengthResolution)  static 

Gets or sets the Wavelength resolution.

**Value type**: Double.





<a id="ac0504254907d817707b6771948e9affe" name="ac0504254907d817707b6771948e9affe"></a>## [◆ ](#ac0504254907d817707b6771948e9affe)WavelengthSampling

 WavelengthSampling = property(fget = \_\_GetWavelengthSampling, fset = \_\_SetWavelengthSampling)  static 

Gets or sets the wavelength sampling.

  
**Value type**: Integer.  
**Range**: The value must be superior to 0.

The default value is 13.





<a id="a437eeee4ad26212fa85c30cfbf5b09c8" name="a437eeee4ad26212fa85c30cfbf5b09c8"></a>## [◆ ](#a437eeee4ad26212fa85c30cfbf5b09c8)WavelengthStart

 WavelengthStart = property(fget = \_\_GetWavelengthStart, fset = \_\_SetWavelengthStart)  static 

Gets or sets the lower value of the wavelength range to be considered by the sensor.

The sensor does not take into account wavelengths beyond the borders that you define.

**Value type**: Double (in nm).

The default value is 400.0 nm.





---

The documentation for this class was generated from the following file:- **SpeosNX.py**