Skip to main content

Speos NX library 2025 R2

ComponentAmbientMaterialBuilder Class Reference

Last update: 16.07.2025

Represents an ambient material component builder. More...

Inheritance diagram for ComponentAmbientMaterialBuilder:
FeatureBuilderBuilder

Static Public Attributes

str Absorption = property(fget=__GetAbsorption, fset=__SetAbsorption)
 Gets or sets the absorption property.
 
str Constringence = property(fget=__GetConstringence, fset=__SetConstringence)
 Gets or sets the constringence property.
 
str Index = property(fget=__GetIndex, fset=__SetIndex)
 Gets or sets the index property.
 
str LibraryFilePath = property(fget=__GetLibraryFilePath, fset=__SetLibraryFilePath)
 Gets or sets the library file path.
 
str Type = property(fget=__GetType, fset=__SetType)
 Gets or sets the type of Ambient Material.
 
str UseConstringence = property(fget=__GetUseConstringence, fset=__SetUseConstringence)
 Gets or sets the use of constringence property.
 
- 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 ambient material component builder.

The ambient material component builder creates or edits ambient material component features.

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

Member Data Documentation

◆ Absorption

str Absorption = property(fget=__GetAbsorption, fset=__SetAbsorption)
static

Gets or sets the absorption property.

Prerequisite: The Type property must be 0.

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

The default value is 0.0.

◆ Constringence

str Constringence = property(fget=__GetConstringence, fset=__SetConstringence)
static

Gets or sets the constringence property.

Prerequisite: The UseConstringence property must be True.

Value type: Double.
Range: The value must be superior or equal to 20.0.

The default value is 60.0

◆ Index

str Index = property(fget=__GetIndex, fset=__SetIndex)
static

Gets or sets the index property.

Prerequisite: The Type property must be 0.

Value type: Double.
Range: The value must be superior or equal to 1.

The default value is 1.5.

◆ LibraryFilePath

str LibraryFilePath = property(fget=__GetLibraryFilePath, fset=__SetLibraryFilePath)
static

Gets or sets the library file path.

Prerequisite: The Type property must be 2.

value type: String.

The default value is an empty string.

◆ Type

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

Gets or sets the type of Ambient Material.

The values are:
0 - Optic.
2 - Library.

Value type: Integer.

The default value is Optic (0).

◆ UseConstringence

str UseConstringence = property(fget=__GetUseConstringence, fset=__SetUseConstringence)
static

Gets or sets the use of constringence property.

Prerequisite: The Type property must be 0.

True: Enables constringence.
False: Disables constringence.

Value type: Boolean.

The default value is False.


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

Connect with Ansys