## 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_2025_r1_1/class_speos_n_x_1_1_sensor_v_r_immersive_builder.png)



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [ActivateAutomaticFraming](#a6e6527ad7fc9c29901db4bc45ef6fc33) = property(fget=\_\_GetActivateAutomaticFraming, fset=\_\_SetActivateAutomaticFraming) Gets or sets the automatic framing property.   
 str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the axis system.   
 str [Back](#ab8cc78fe606b43dcfd75b425ecb50aab) = property(fget=\_\_GetBack, fset=\_\_SetBack) Gets or sets the back face property.   
 str [Bottom](#a23145861dc2dc3714a9e59b83d6eb21f) = property(fget=\_\_GetBottom, fset=\_\_SetBottom) Gets or sets the bottom face property.   
 str [FramingFace](#ab21911c1b91cdeaf25785caf0c7ae862) = property(fget=\_\_GetFramingFace, fset=\_\_SetFramingFace) Gets or sets the framing face.   
 str [Front](#af0c66d5ed996cb2b6fcdde29e1682df9) = property(fget=\_\_GetFront, fset=\_\_SetFront) Gets or sets the front face property.   
 str [IntegrationAngle](#aafed16fbbcc425503a9e4068b1eb0b20) = property(fget=\_\_GetIntegrationAngle, fset=\_\_SetIntegrationAngle) Gets or sets the integration angle.   
 str [InterocularDistance](#ae4e620b958b8da81f6f40dc704b6d6b0) = property(fget=\_\_GetInterocularDistance, fset=\_\_SetInterocularDistance) Gets or set the interocular distance.   
 str [Layer](#a80837300dfb3751c003ebb2bce3946ef) = property(fget=\_\_GetLayer, fset=\_\_SetLayer) Gets or sets the layer mode.   
 str [Left](#a7e166995c8aa86e4099c22a6eda92a13) = property(fget=\_\_GetLeft, fset=\_\_SetLeft) Gets or sets the left face property.   
 str [PreviewSize](#a6aa632655e525d1b227f78dfa7b3ed4f) = property(fget=\_\_GetPreviewSize, fset=\_\_SetPreviewSize) Gets or sets the preview arrows size.   
 str [Resolution](#af897195b5b95bc10b62b5979d2366dd7) = property(fget=\_\_GetResolution) Gets the resolution.   
 str [Right](#afa6399396c675549bd8e472b414df70b) = property(fget=\_\_GetRight, fset=\_\_SetRight) Gets or sets the right face property.   
 str [Sampling](#a5133a8dac7ecfd965f729b1d3bd64b6e) = property(fget=\_\_GetSampling, fset=\_\_SetSampling) Gets or sets the sampling.   
 str [Stereo](#a08b74596f98ea79151b51f8c90b06580) = property(fget=\_\_GetStereo, fset=\_\_SetStereo) gets or sets the stereo property.   
 str [Top](#ad1c33a4ccd85257d0747b195ec26e9c7) = property(fget=\_\_GetTop, fset=\_\_SetTop) Gets or sets the top face property.   
 str [WavelengthEnd](#a1d3af865fff16f6eb31305404623a867) = property(fget=\_\_GetWavelengthEnd, fset=\_\_SetWavelengthEnd) Gets or sets the higher value of the wavelength range to be considered by the sensor.   
 str [WavelengthResolution](#a4d829d8a46f0614c7c32b78ae1602fd9) = property(fget=\_\_GetWavelengthResolution, fset=\_\_SetWavelengthResolution) Gets or sets the Wavelength resolution.   
 str [WavelengthSampling](#a1a2c2043920b4b7bb6308cb22e73ec13) = property(fget=\_\_GetWavelengthSampling, fset=\_\_SetWavelengthSampling) Gets or sets the wavelength sampling.   
 ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) 'None' [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
  'None' **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>



## Member Data Documentation

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

 str 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="af0a012d49a5b59a4f43bb342b8c725c2" name="af0a012d49a5b59a4f43bb342b8c725c2"></a>## [◆ ](#af0a012d49a5b59a4f43bb342b8c725c2)AxisSystem

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

Gets the axis system.

**Value type**: AxisSytem object.





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

 str 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="a23145861dc2dc3714a9e59b83d6eb21f" name="a23145861dc2dc3714a9e59b83d6eb21f"></a>## [◆ ](#a23145861dc2dc3714a9e59b83d6eb21f)Bottom

 str 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="ab21911c1b91cdeaf25785caf0c7ae862" name="ab21911c1b91cdeaf25785caf0c7ae862"></a>## [◆ ](#ab21911c1b91cdeaf25785caf0c7ae862)FramingFace

 str 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="af0c66d5ed996cb2b6fcdde29e1682df9" name="af0c66d5ed996cb2b6fcdde29e1682df9"></a>## [◆ ](#af0c66d5ed996cb2b6fcdde29e1682df9)Front

 str 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="aafed16fbbcc425503a9e4068b1eb0b20" name="aafed16fbbcc425503a9e4068b1eb0b20"></a>## [◆ ](#aafed16fbbcc425503a9e4068b1eb0b20)IntegrationAngle

 str 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="ae4e620b958b8da81f6f40dc704b6d6b0" name="ae4e620b958b8da81f6f40dc704b6d6b0"></a>## [◆ ](#ae4e620b958b8da81f6f40dc704b6d6b0)InterocularDistance

 str 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="a80837300dfb3751c003ebb2bce3946ef" name="a80837300dfb3751c003ebb2bce3946ef"></a>## [◆ ](#a80837300dfb3751c003ebb2bce3946ef)Layer

 str 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="a7e166995c8aa86e4099c22a6eda92a13" name="a7e166995c8aa86e4099c22a6eda92a13"></a>## [◆ ](#a7e166995c8aa86e4099c22a6eda92a13)Left

 str 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="a6aa632655e525d1b227f78dfa7b3ed4f" name="a6aa632655e525d1b227f78dfa7b3ed4f"></a>## [◆ ](#a6aa632655e525d1b227f78dfa7b3ed4f)PreviewSize

 str 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="af897195b5b95bc10b62b5979d2366dd7" name="af897195b5b95bc10b62b5979d2366dd7"></a>## [◆ ](#af897195b5b95bc10b62b5979d2366dd7)Resolution

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

Gets the resolution.

**Value type**: Double.





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

 str 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="a5133a8dac7ecfd965f729b1d3bd64b6e" name="a5133a8dac7ecfd965f729b1d3bd64b6e"></a>## [◆ ](#a5133a8dac7ecfd965f729b1d3bd64b6e)Sampling

 str 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="a08b74596f98ea79151b51f8c90b06580" name="a08b74596f98ea79151b51f8c90b06580"></a>## [◆ ](#a08b74596f98ea79151b51f8c90b06580)Stereo

 str 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="ad1c33a4ccd85257d0747b195ec26e9c7" name="ad1c33a4ccd85257d0747b195ec26e9c7"></a>## [◆ ](#ad1c33a4ccd85257d0747b195ec26e9c7)Top

 str 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="a1d3af865fff16f6eb31305404623a867" name="a1d3af865fff16f6eb31305404623a867"></a>## [◆ ](#a1d3af865fff16f6eb31305404623a867)WavelengthEnd

 str 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="a4d829d8a46f0614c7c32b78ae1602fd9" name="a4d829d8a46f0614c7c32b78ae1602fd9"></a>## [◆ ](#a4d829d8a46f0614c7c32b78ae1602fd9)WavelengthResolution

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

Gets or sets the Wavelength resolution.

**Value type**: Double.





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

 str 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.





---

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