NXOpen::Display::LayerSettingsBuilder Class Reference

Represents a builder for object layer settings. More...

Inheritance diagram for NXOpen::Display::LayerSettingsBuilder:

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.
int	Layer ()
	Returns the layer.
NXOpen::Display::LayerSettingsBuilder::LayerOptionType	LayerOption ()
	Returns the layer option.
void	SetLayer (int layer)
	Sets the layer.
void	SetLayerOption (NXOpen::Display::LayerSettingsBuilder::LayerOptionType layerOption)
	Sets the layer option.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a builder for object layer settings.

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Display::LayerSettingsBuilder::LayerOptionType

Specifies the layer options.

Enumerator:

LayerOptionTypeMaintain	Maintain layer.
LayerOptionTypeOriginal	Original layer.
LayerOptionTypeWork	Work layer.
LayerOptionTypeUserDefined	User specified layer.

Member Function Documentation

bool NXOpen::Display::LayerSettingsBuilder::IsValidLayerOption

(

NXOpen::Display::LayerSettingsBuilder::LayerOptionType

layerOption

)

Determines if the layer option is supported.

        <br> 
       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.
       <ul>
       <li>@link Display::LayerSettingsBuilder::LayerOptionTypeMaintain Display::LayerSettingsBuilder::LayerOptionTypeMaintain@endlink </li>
       <li>@link Display::LayerSettingsBuilder::LayerOptionTypeOriginal Display::LayerSettingsBuilder::LayerOptionTypeOriginal@endlink </li>
       </ul>
        <br> 
      @return  

Created in NX9.0.0.

License requirements : None

Parameters

layerOption

layeroption

int NXOpen::Display::LayerSettingsBuilder::Layer

(

)

Returns the layer.

        <br> 
       Used when the layer option is set to
       @link Display::LayerSettingsBuilder::LayerOptionTypeUserDefined
        Display::LayerSettingsBuilder::LayerOptionTypeUserDefined
       @endlink . See @link NXOpen::Layer::Constants NXOpen::Layer::Constants@endlink  for 
       valid layer values.
        <br> 

Created in NX9.0.0.

License requirements : None

NXOpen::Display::LayerSettingsBuilder::LayerOptionType NXOpen::Display::LayerSettingsBuilder::LayerOption

(

)

Returns the layer option.

        <br> 
       Note that all layer options may not be supported by the builder.
       Refer @link Display::LayerSettingsBuilder::IsValidLayerOption
        Display::LayerSettingsBuilder::IsValidLayerOption
       @endlink  to determine supported options.
        <br> 

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::LayerSettingsBuilder::SetLayer

(

int

layer

)

Sets the layer.

        <br> 
       Used when the layer option is set to
       @link Display::LayerSettingsBuilder::LayerOptionTypeUserDefined
        Display::LayerSettingsBuilder::LayerOptionTypeUserDefined
       @endlink . See @link NXOpen::Layer::Constants NXOpen::Layer::Constants@endlink  for 
       valid layer values.
        <br> 

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.

        <br> 
       Note that all layer options may not be supported by the builder.
       Refer @link Display::LayerSettingsBuilder::IsValidLayerOption
        Display::LayerSettingsBuilder::IsValidLayerOption
       @endlink  to determine supported options.
        <br> 

Created in NX9.0.0.

License requirements : None

Parameters

layerOption

layeroption

virtual bool NXOpen::Display::LayerSettingsBuilder::Validate ( )

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