Skip to main content

Speos NX library 2025 R2

SourceInteractiveBuilder Class Reference

Last update: 16.07.2025

Represents an interactive source builder. More...

Inheritance diagram for SourceInteractiveBuilder:
FeatureBuilderBuilder

Static Public Attributes

str EndCurve = property(fget=__GetEndCurve, fset=__SetEndCurve)
 Gets or sets the end curve.
 
str EndDirection = property(fget=__GetEndDirection, fset=__SetEndDirection)
 Gets or sets the end direction.
 
str EndDirectionReversed = property(fget=__GetEndDirectionReversed, fset=__SetEndDirectionReversed)
 Gets or sets the property to reverse the end direction.
 
str EndFace = property(fget=__GetEndFace, fset=__SetEndFace)
 Gets or sets the end face.
 
str EndFirstSampling = property(fget=__GetEndFirstSampling, fset=__SetEndFirstSampling)
 Gets or sets the end first sampling.
 
str EndPoint = property(fget=__GetEndPoint, fset=__SetEndPoint)
 Gets or sets the end point.
 
str EndSecondSampling = property(fget=__GetEndSecondSampling, fset=__SetEndSecondSampling)
 Gets or sets the end second sampling.
 
str RayLength = property(fget=__GetRayLength, fset=__SetRayLength)
 Gets or sets the ray length.
 
str StartCurve = property(fget=__GetStartCurve, fset=__SetStartCurve)
 Gets or sets the start curve.
 
str StartFace = property(fget=__GetStartFace, fset=__SetStartFace)
 Gets or sets the start face.
 
str StartFirstSampling = property(fget=__GetStartFirstSampling, fset=__SetStartFirstSampling)
 Gets or sets the start first sampling.
 
str StartPoint = property(fget=__GetStartPoint, fset=__SetStartPoint)
 Gets or sets the start point.
 
str StartSecondSampling = property(fget=__GetStartSecondSampling, fset=__SetStartSecondSampling)
 Gets or sets the start second sampling.
 
str Type = property(fget=__GetType, fset=__SetType)
 Gets or sets the interactive source type.
 
str Wavelength = property(fget=__GetWavelength, fset=__SetWavelength)
 Gets or sets the wavelength.
 
- 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.
 
str Status = property(fget=__GetStatus)
 Returns the status of the feature being edited.
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 
- Properties inherited from FeatureBuilder
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 
- Properties inherited from Builder
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 

Additional Inherited Members

- Public Member Functions inherited from FeatureBuilder
'None' ShowResult (self)
 Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.
 
- Public Member Functions inherited from Builder
'None' Commit (self)
 Commits any edits that have been applied to the builder.
 

Detailed Description

Represents an interactive source builder.

The interactive source builder creates or edits interactive source features.

To create a new instance of this class, use FeatureCollection::CreateSourceInteractiveBuilder.

Member Data Documentation

◆ EndCurve

str EndCurve = property(fget=__GetEndCurve, fset=__SetEndCurve)
static

Gets or sets the end curve.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ EndDirection

str EndDirection = property(fget=__GetEndDirection, fset=__SetEndDirection)
static

Gets or sets the end direction.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ EndDirectionReversed

str EndDirectionReversed = property(fget=__GetEndDirectionReversed, fset=__SetEndDirectionReversed)
static

Gets or sets the property to reverse the end direction.

True: Reverses the direction.
False: Does not reverse the direction.

Value type: Boolean.

The default value is False.

◆ EndFace

str EndFace = property(fget=__GetEndFace, fset=__SetEndFace)
static

Gets or sets the end face.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ EndFirstSampling

str EndFirstSampling = property(fget=__GetEndFirstSampling, fset=__SetEndFirstSampling)
static

Gets or sets the end first sampling.

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

The default value is 5.

◆ EndPoint

str EndPoint = property(fget=__GetEndPoint, fset=__SetEndPoint)
static

Gets or sets the end point.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ EndSecondSampling

str EndSecondSampling = property(fget=__GetEndSecondSampling, fset=__SetEndSecondSampling)
static

Gets or sets the end second sampling.

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

The default value is 5.

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

◆ StartCurve

str StartCurve = property(fget=__GetStartCurve, fset=__SetStartCurve)
static

Gets or sets the start curve.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ StartFace

str StartFace = property(fget=__GetStartFace, fset=__SetStartFace)
static

Gets or sets the start face.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ StartFirstSampling

str StartFirstSampling = property(fget=__GetStartFirstSampling, fset=__SetStartFirstSampling)
static

Gets or sets the start first sampling.

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

The default value is 5.

◆ StartPoint

str StartPoint = property(fget=__GetStartPoint, fset=__SetStartPoint)
static

Gets or sets the start point.

The property takes a feature tag and returns a feature tag.

Value type: Integer.

The default value is 0.

◆ StartSecondSampling

str StartSecondSampling = property(fget=__GetStartSecondSampling, fset=__SetStartSecondSampling)
static

Gets or sets the start second sampling.

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

The default value is 5.

◆ Type

str Type = property(fget=__GetType, fset=__SetType)
static

Gets or sets the interactive source type.

The values are:
0 - POINT_POINT.
1 - POINT_DIRECTION.
2 - POINT_CURVE.
3 - POINT_FACE.
4 - CURVE_POINT.
5 - CURVE_DIRECTION.
6 - CURVE_CURVE.
7 - CURVE_FACE.
8 - FACE_POINT.
9 - FACE_DIRECTION.
10 - FACE_CURVE.
11 - FACE_FACE.

Value type: Integer.

The default value is 2 - POINT_CURVE.

◆ Wavelength

str Wavelength = property(fget=__GetWavelength, fset=__SetWavelength)
static

Gets or sets the wavelength.

Prerequisite: The SpectrumType property must be 0.

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

The default value is 555.0 nm.


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

Connect with Ansys