Represents a builder for object layer settings. More...
Public Types | |
| enum | LayerOptionType { LayerOptionTypeMaintain, LayerOptionTypeOriginal, LayerOptionTypeWork, LayerOptionTypeUserDefined } |
| Specifies the layer options. More... | |
Public Member Functions | |
| bool | IsValidLayerOption (NXOpen::Display::LayerSettingsBuilder::LayerOptionType layerOption) |
| Determines if the layer option is supported. More... | |
| int | Layer () |
| Returns the layer. More... | |
| NXOpen::Display::LayerSettingsBuilder::LayerOptionType | LayerOption () |
| Returns the layer option. More... | |
| void | SetLayer (int layer) |
| Sets the layer. More... | |
| void | SetLayerOption (NXOpen::Display::LayerSettingsBuilder::LayerOptionType layerOption) |
| Sets the layer option. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
 Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents a builder for object layer settings.
Created in NX9.0.0.
Member Enumeration Documentation
Member Function Documentation
| bool NXOpen::Display::LayerSettingsBuilder::IsValidLayerOption | ( | NXOpen::Display::LayerSettingsBuilder::LayerOptionType | layerOption | ) |
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::LayerSettingsBuilder::LayerOptionTypeMaintain
- Display::LayerSettingsBuilder::LayerOptionTypeOriginal
- Returns
Created in NX9.0.0.
License requirements : None
- Parameters
-
layerOption layeroption
| int NXOpen::Display::LayerSettingsBuilder::Layer | ( | ) |
Returns the layer.
Used when the layer option is set to Display::LayerSettingsBuilder::LayerOptionTypeUserDefined . See NXOpen::Layer::Constants for valid layer values.
Created in NX9.0.0.
License requirements : None
| NXOpen::Display::LayerSettingsBuilder::LayerOptionType NXOpen::Display::LayerSettingsBuilder::LayerOption | ( | ) |
Returns the layer option.
Note that all layer options may not be supported by the builder. Refer Display::LayerSettingsBuilder::IsValidLayerOption to determine supported options.
Created in NX9.0.0.
License requirements : None
| void NXOpen::Display::LayerSettingsBuilder::SetLayer | ( | int | layer | ) |
Sets the layer.
Used when the layer option is set to Display::LayerSettingsBuilder::LayerOptionTypeUserDefined . See NXOpen::Layer::Constants for valid layer values.
Created in NX9.0.0.
License requirements : None
- Parameters
-
layer layer
| void NXOpen::Display::LayerSettingsBuilder::SetLayerOption | ( | NXOpen::Display::LayerSettingsBuilder::LayerOptionType | layerOption | ) |
Sets the layer option.
Note that all layer options may not be supported by the builder. Refer Display::LayerSettingsBuilder::IsValidLayerOption to determine supported options.
Created in NX9.0.0.
License requirements : None
- Parameters
-
layerOption layeroption
|
virtual |
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.
- Returns
- Was self validation successful
Created in NX3.0.1.
License requirements : None
Implements NXOpen::GeometricUtilities::IComponentBuilder.
The documentation for this class was generated from the following file:
- Display_LayerSettingsBuilder.hxx