Skip to main content

Speos NX library 2025 R1

SourceLightFieldBuilder Class Reference

Last update: 17.07.2025
Inheritance diagram for SourceLightFieldBuilder:
FeatureBuilder_object

Static Public Attributes

str AxisSystem = property(fget=__GetAxisSystem)
 Gets the Axis System of the source.
 
str CustomAxisSystem = property(fget=__GetCustomAxisSystem, fset=__SetCustomAxisSystem)
 Gets or sets the custom axis system property.
 
str LightFieldFilePath = property(fget=__GetLightFieldFilePath, fset=__SetLightFieldFilePath)
 Gets or sets the light field file path.
 
str NumberOfRays = property(fget=__GetNumberOfRays, fset=__SetNumberOfRays)
 Gets or sets the number of rays.
 
str PreviewMode = property(fget=__GetPreviewMode, fset=__SetPreviewMode)
 Gets or sets the preview mode.
 
str RayLength = property(fget=__GetRayLength, fset=__SetRayLength)
 Gets or sets the ray length.
 
- Static Public Attributes inherited from FeatureBuilder
str Feature = property(fget=__GetFeature)
 Returns the feature being edited, or the created feature if the builder is being used in creation mode.
 
str FullName = property(fget=__GetFullName)
 Gets the full name of the feature being edited.
 
str Name = property(fget=__GetName, fset=__SetName)
 Gets or sets the name of the feature being edited.
 
str NameWithContext = property(fget=__GetNameWithContext)
 Gets the name with context of the feature being edited.
 

Additional Inherited Members

- Public Member Functions inherited from FeatureBuilder
'None' Commit (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.
 

Member Data Documentation

◆ AxisSystem

str AxisSystem = property(fget=__GetAxisSystem)
static

Gets the Axis System of the source.

Prerequisite: The CustomAxisSystem property must be True.

Value type: AxisSystem object.

◆ CustomAxisSystem

str CustomAxisSystem = property(fget=__GetCustomAxisSystem, fset=__SetCustomAxisSystem)
static

Gets or sets the custom axis system property.

True: Enables custom axis system.
False: Disables custom axis system.

Value type: Boolean.

The default value is False.

◆ LightFieldFilePath

str LightFieldFilePath = property(fget=__GetLightFieldFilePath, fset=__SetLightFieldFilePath)
static

Gets or sets the light field file path.

Value type: String.

The default value is an empty string.

◆ NumberOfRays

str NumberOfRays = property(fget=__GetNumberOfRays, fset=__SetNumberOfRays)
static

Gets or sets the number of rays.

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

The default value is 100.

◆ PreviewMode

str PreviewMode = property(fget=__GetPreviewMode, fset=__SetPreviewMode)
static

Gets or sets the preview mode.

The values are:
0 - Meshing.
1 - BoundingBox.

Value type: Integer.

The default value is 0.

◆ RayLength

str RayLength = property(fget=__GetRayLength, fset=__SetRayLength)
static

Gets or sets the ray length.

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

The default value is 75.0 mm.


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

Connect with Ansys