NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::RadialStyleBuilder Class Reference

Represents a NXOpen::Annotations::RadialStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::RadialStyleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Annotations::DiameterRadiusSymbolPlacement DiameterRadiusPlacement ()
 Returns the diameter radius symbol placement with respect to the dimension text. More...
 
NXString DiameterSymbol ()
 Returns the text for a user-defined diameter symbol
Created in NX6.0.0. More...
 
NXOpen::Annotations::DiameterSymbol DiameterSymbolType ()
 Returns the diameter symbol type
Created in NX6.0.0. More...
 
double FoldedRadiusAngle ()
 Returns the folded radius angle
Created in NX6.0.0. More...
 
NXString RadiusSymbol ()
 Returns the text for a user-defined radius symbol
Created in NX6.0.0. More...
 
NXOpen::Annotations::RadiusSymbol RadiusSymbolType ()
 Returns the radius symbol type
Created in NX6.0.0. More...
 
void SetDiameterRadiusPlacement (NXOpen::Annotations::DiameterRadiusSymbolPlacement diameterRadiusPlacement)
 Sets the diameter radius symbol placement with respect to the dimension text. More...
 
void SetDiameterSymbol (const NXString &diameterSymbol)
 Sets the text for a user-defined diameter symbol
Created in NX6.0.0. More...
 
void SetDiameterSymbol (const char *diameterSymbol)
 Sets the text for a user-defined diameter symbol
Created in NX6.0.0. More...
 
void SetDiameterSymbolType (NXOpen::Annotations::DiameterSymbol diameterSymbolType)
 Sets the diameter symbol type
Created in NX6.0.0. More...
 
void SetFoldedRadiusAngle (double foldedRadiusAngle)
 Sets the folded radius angle
Created in NX6.0.0. More...
 
void SetRadiusSymbol (const NXString &radiusSymbol)
 Sets the text for a user-defined radius symbol
Created in NX6.0.0. More...
 
void SetRadiusSymbol (const char *radiusSymbol)
 Sets the text for a user-defined radius symbol
Created in NX6.0.0. More...
 
void SetRadiusSymbolType (NXOpen::Annotations::RadiusSymbol radiusSymbolType)
 Sets the radius symbol type
Created in NX6.0.0. More...
 
void SetSymbolToDimensionTextDistance (double symbolToDimensionTextDistance)
 Sets the symbol to dimension text distance in character spaces
Created in NX6.0.0. More...
 
void SetTextAboveLeader (NXOpen::Annotations::DiameterRadiusLeaderStub textAboveLeader)
 Sets the location of the dimension text relative to the leader stub
More...
 
double SymbolToDimensionTextDistance ()
 Returns the symbol to dimension text distance in character spaces
Created in NX6.0.0. More...
 
NXOpen::Annotations::DiameterRadiusLeaderStub TextAboveLeader ()
 Returns the location of the dimension text relative to the leader stub
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 NXOpen::Annotations::RadialStyleBuilder .

This class queries and sets preferences specific to radial dimensions when creating or editing a radial type dimension.


Created in NX6.0.0.

Member Function Documentation

NXOpen::Annotations::DiameterRadiusSymbolPlacement NXOpen::Annotations::RadialStyleBuilder::DiameterRadiusPlacement ( )

Returns the diameter radius symbol placement with respect to the dimension text.

One of the options specifies that no symbol be displayed
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::RadialStyleBuilder::DiameterSymbol ( )

Returns the text for a user-defined diameter symbol
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::DiameterSymbol NXOpen::Annotations::RadialStyleBuilder::DiameterSymbolType ( )

Returns the diameter symbol type
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::RadialStyleBuilder::FoldedRadiusAngle ( )

Returns the folded radius angle
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::RadialStyleBuilder::RadiusSymbol ( )

Returns the text for a user-defined radius symbol
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::RadiusSymbol NXOpen::Annotations::RadialStyleBuilder::RadiusSymbolType ( )

Returns the radius symbol type
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::RadialStyleBuilder::SetDiameterRadiusPlacement ( NXOpen::Annotations::DiameterRadiusSymbolPlacement  diameterRadiusPlacement)

Sets the diameter radius symbol placement with respect to the dimension text.

One of the options specifies that no symbol be displayed
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
diameterRadiusPlacementdiameterradiusplacement
void NXOpen::Annotations::RadialStyleBuilder::SetDiameterSymbol ( const NXString diameterSymbol)

Sets the text for a user-defined diameter symbol
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
diameterSymboldiametersymbol
void NXOpen::Annotations::RadialStyleBuilder::SetDiameterSymbol ( const char *  diameterSymbol)

Sets the text for a user-defined diameter symbol
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
diameterSymboldiametersymbol
void NXOpen::Annotations::RadialStyleBuilder::SetDiameterSymbolType ( NXOpen::Annotations::DiameterSymbol  diameterSymbolType)

Sets the diameter symbol type
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
diameterSymbolTypediametersymboltype
void NXOpen::Annotations::RadialStyleBuilder::SetFoldedRadiusAngle ( double  foldedRadiusAngle)

Sets the folded radius angle
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
foldedRadiusAnglefoldedradiusangle
void NXOpen::Annotations::RadialStyleBuilder::SetRadiusSymbol ( const NXString radiusSymbol)

Sets the text for a user-defined radius symbol
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
radiusSymbolradiussymbol
void NXOpen::Annotations::RadialStyleBuilder::SetRadiusSymbol ( const char *  radiusSymbol)

Sets the text for a user-defined radius symbol
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
radiusSymbolradiussymbol
void NXOpen::Annotations::RadialStyleBuilder::SetRadiusSymbolType ( NXOpen::Annotations::RadiusSymbol  radiusSymbolType)

Sets the radius symbol type
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
radiusSymbolTyperadiussymboltype
void NXOpen::Annotations::RadialStyleBuilder::SetSymbolToDimensionTextDistance ( double  symbolToDimensionTextDistance)

Sets the symbol to dimension text distance in character spaces
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
symbolToDimensionTextDistancesymboltodimensiontextdistance
void NXOpen::Annotations::RadialStyleBuilder::SetTextAboveLeader ( NXOpen::Annotations::DiameterRadiusLeaderStub  textAboveLeader)

Sets the location of the dimension text relative to the leader stub

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DimensionStyleBuilder::SetTextPosition instead.


Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
textAboveLeadertextaboveleader
double NXOpen::Annotations::RadialStyleBuilder::SymbolToDimensionTextDistance ( )

Returns the symbol to dimension text distance in character spaces
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::DiameterRadiusLeaderStub NXOpen::Annotations::RadialStyleBuilder::TextAboveLeader ( )

Returns the location of the dimension text relative to the leader stub

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DimensionStyleBuilder::TextPosition instead.


Created in NX6.0.0.

License requirements : None

virtual bool NXOpen::Annotations::RadialStyleBuilder::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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.