LayerSettingsBuilder Class

class NXOpen.Display.LayerSettingsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a builder for object layer settings.

New in version NX9.0.0.

Properties

Property	Description
Layer	Returns or sets the layer.
LayerOption	Returns or sets the layer option.
Tag	Returns the Tag for this object.

Methods

Method	Description
IsValidLayerOption	Determines if the layer option is supported.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

LayerSettingsBuilderLayerOptionType Enumeration

Specifies the layer options.

Property Detail

Layer

LayerSettingsBuilder.Layer

Returns or sets the layer.

Used when the layer option is set to Display.LayerSettingsBuilderLayerOptionType.UserDefined. See NXOpen.Layer.Constants for valid layer values.

-------------------------------------

Getter Method

Signature Layer

Returns: Return type:int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Layer

Parameters:layer (int) –

New in version NX9.0.0.

License requirements: None.

LayerOption

LayerSettingsBuilder.LayerOption

Returns or sets the layer option.

Note that all layer options may not be supported by the builder. Refer Display.LayerSettingsBuilder.IsValidLayerOption() to determine supported options.

-------------------------------------

Getter Method

Signature LayerOption

Returns: Return type:NXOpen.Display.LayerSettingsBuilderLayerOptionType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LayerOption

Parameters:layerOption (NXOpen.Display.LayerSettingsBuilderLayerOptionType) –

New in version NX9.0.0.

License requirements: None.

Method Detail

IsValidLayerOption

LayerSettingsBuilder.IsValidLayerOption

Determines if the layer option is supported.

The parent builder determines the validity of the layer options. For example, following layer options are not relevant when the layer is not being derived from another displayable object.

• Display.LayerSettingsBuilderLayerOptionType.Maintain
• Display.LayerSettingsBuilderLayerOptionType.Original

Signature IsValidLayerOption(layerOption)

Parameters:layerOption (NXOpen.Display.LayerSettingsBuilderLayerOptionType) – Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

Validate

LayerSettingsBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.