Represents a WidthDefinition , which is a representation of an NX width palette. More...
Public Member Functions | |
| std::vector< NXOpen::ColorWidth * > | GetColorWidths () |
| Gets the color widths. | |
| std::vector < NXOpen::CustomWidth * > | GetCustomWidths () |
| Gets the custom widths array. | |
| void | SetSingle (int single) |
| Sets the single width type selection Created in NX5.0.0. | |
| void | SetSingleSource (int singleSource) |
| Sets the single source. | |
| void | SetSingleWidth (double singleWidth) |
| Sets the single width. | |
| void | SetUnits (int units) |
| Sets the units. | |
| void | SetUse (int use) |
| Sets the 'use' member. | |
| int | Single () |
| Returns the single width type selection Created in NX5.0.0. | |
| int | SingleSource () |
| Returns the single source. | |
| double | SingleWidth () |
| Returns the single width. | |
| int | Units () |
| Returns the units. | |
| int | Use () |
| Returns the 'use' member. | |
 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 WidthDefinition , which is a representation of an NX width palette.
It gives the units in which all the widths are stored, single width information, the 3 custom width definitions, and an entry for each color.
Created in NX5.0.0.
Member Function Documentation
| std::vector<NXOpen::ColorWidth *> NXOpen::WidthDefinition::GetColorWidths | ( | ) |
Gets the color widths.
The 'widths' array is indexed by the color index straight out of the database, or 1-216. Therefore the array is one longer than the actual number of colors, or 217.
- Returns
- Array of ColorWidth objects.
Created in NX5.0.0.
License requirements : None
| std::vector<NXOpen::CustomWidth *> NXOpen::WidthDefinition::GetCustomWidths | ( | ) |
Gets the custom widths array.
There will be 3 CustomWidth objects.
- Returns
- Array of CustomWidth objects.
Created in NX5.0.0.
License requirements : None
| void NXOpen::WidthDefinition::SetSingle | ( | int | single | ) |
Sets the single width type selection
Created in NX5.0.0.
License requirements : None
- Parameters
-
single single
| void NXOpen::WidthDefinition::SetSingleSource | ( | int | singleSource | ) |
Sets the single source.
The 'single_source' member contains a value when the 'single' member is CGME_width_std or CGME_width_custom. The value is the index in the 'custom' width array or the standard width index value. Both are assumed to be in internal order, normal, thick, and thin for 0, 1, and 2, respectively.
Created in NX5.0.0.
License requirements : None
- Parameters
-
singleSource singlesource
| void NXOpen::WidthDefinition::SetSingleWidth | ( | double | singleWidth | ) |
Sets the single width.
The 'single_width' member contains the last-typed value for the user-defined width to use when CGME_width_user is selected for member 'single'.
Created in NX5.0.0.
License requirements : None
- Parameters
-
singleWidth singlewidth
| void NXOpen::WidthDefinition::SetUnits | ( | int | units | ) |
Sets the units.
All the widths are stored in these units.
Created in NX5.0.0.
License requirements : None
- Parameters
-
units units
| void NXOpen::WidthDefinition::SetUse | ( | int | use | ) |
Sets the 'use' member.
The use member specifies the primary selection of which type of width assignment to use.
Created in NX5.0.0.
License requirements : None
- Parameters
-
use use
| int NXOpen::WidthDefinition::Single | ( | ) |
Returns the single width type selection
Created in NX5.0.0.
License requirements : None
| int NXOpen::WidthDefinition::SingleSource | ( | ) |
Returns the single source.
The 'single_source' member contains a value when the 'single' member is CGME_width_std or CGME_width_custom. The value is the index in the 'custom' width array or the standard width index value. Both are assumed to be in internal order, normal, thick, and thin for 0, 1, and 2, respectively.
Created in NX5.0.0.
License requirements : None
| double NXOpen::WidthDefinition::SingleWidth | ( | ) |
Returns the single width.
The 'single_width' member contains the last-typed value for the user-defined width to use when CGME_width_user is selected for member 'single'.
Created in NX5.0.0.
License requirements : None
| int NXOpen::WidthDefinition::Units | ( | ) |
Returns the units.
All the widths are stored in these units.
Created in NX5.0.0.
License requirements : None
| int NXOpen::WidthDefinition::Use | ( | ) |
Returns the 'use' member.
The use member specifies the primary selection of which type of width assignment to use.
Created in NX5.0.0.
License requirements : None
The documentation for this class was generated from the following file:
- WidthDefinition.hxx