Represents a Weld::DatumIconBuilder class used to control the part navigator icon for Datum Pin and Surface Locators. More...
Public Member Functions | |
| NXOpen::Weld::DatumCommonBuilder::CustomTypes | CustomType () |
| Returns the custom datum type from the customer defaults that was used. | |
| NXOpen::Weld::DatumPin * | DatumPin () |
| Returns the DatumPin feature. | |
| NXOpen::Weld::DatumSurface * | DatumSurface () |
| Returns the DatumSurface feature. | |
| bool | Derived () |
| Returns the indicator if this datum was derived from another datum. | |
| NXString | IconName () |
| Returns the bit map name for the icon to be used. | |
| void | SetIconName (const NXString &iconName) |
| Sets the bit map name for the icon to be used. | |
| void | SetIconName (const char *iconName) |
| Sets the bit map name for the icon to be used. | |
| 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 Weld::DatumIconBuilder class used to control the part navigator icon for Datum Pin and Surface Locators.
This class is used to set the Datum Surface or Datum Pin icon, but never both at the same time. If the icon is not being set for a feature, that feature will be set to NULL. See example in DatumIconCallback.cxx in ugweld/samples kit.
Created in NX9.0.0.
Member Function Documentation
| NXOpen::Weld::DatumCommonBuilder::CustomTypes NXOpen::Weld::DatumIconBuilder::CustomType | ( | ) |
Returns the custom datum type from the customer defaults that was used.
Created in NX9.0.0.
License requirements : None
| NXOpen::Weld::DatumPin* NXOpen::Weld::DatumIconBuilder::DatumPin | ( | ) |
Returns the DatumPin feature.
This will be NULL if setting the icon for a DatumSurface
Created in NX9.0.0.
License requirements : None
| NXOpen::Weld::DatumSurface* NXOpen::Weld::DatumIconBuilder::DatumSurface | ( | ) |
Returns the DatumSurface feature.
This will be NULL if setting the icon for a DatumPin.
Created in NX9.0.0.
License requirements : None
| bool NXOpen::Weld::DatumIconBuilder::Derived | ( | ) |
Returns the indicator if this datum was derived from another datum.
Created in NX9.0.0.
License requirements : None
| NXString NXOpen::Weld::DatumIconBuilder::IconName | ( | ) |
Returns the bit map name for the icon to be used.
If the bit map cannot be found a default one will be used.
Created in NX9.0.0.
License requirements : None
| void NXOpen::Weld::DatumIconBuilder::SetIconName | ( | const NXString & | iconName | ) |
Sets the bit map name for the icon to be used.
If the bit map cannot be found a default one will be used.
Created in NX9.0.0.
License requirements : None
- Parameters
-
iconName iconname
| void NXOpen::Weld::DatumIconBuilder::SetIconName | ( | const char * | iconName | ) |
Sets the bit map name for the icon to be used.
If the bit map cannot be found a default one will be used.
Created in NX9.0.0.
License requirements : None
- Parameters
-
iconName iconname
|
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:
- Weld_DatumIconBuilder.hxx