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

Represents a NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder builder
Created in NX10.0.0. More...

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

Public Types

enum  MethodType { MethodTypeWidthAndAngle, MethodTypeWidthAndHeight }
 Represents foreshortening symbol method type. More...
 
enum  SymbolType { SymbolTypeRegular, SymbolTypeStretched }
 Represents foreshortening symbol type. More...
 

Public Member Functions

double Angle ()
 Returns the foreshortening symbol angle
Created in NX10.0.0. More...
 
NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::MethodType ForeshorteningSymbolMethodType ()
 Returns the foreshortening symbol method
Created in NX10.0.0. More...
 
NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SymbolType ForeshorteningSymbolType ()
 Returns the foreshortening symbol type
Created in NX10.0.0. More...
 
double Height ()
 Returns the foreshortening symbol height
Created in NX10.0.0. More...
 
void SetAngle (double foreshorteningSymbolAngle)
 Sets the foreshortening symbol angle
Created in NX10.0.0. More...
 
void SetForeshorteningSymbolMethodType (NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::MethodType foreshorteningSymbolMethod)
 Sets the foreshortening symbol method
Created in NX10.0.0. More...
 
void SetForeshorteningSymbolType (NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SymbolType foreshorteningSymbolType)
 Sets the foreshortening symbol type
Created in NX10.0.0. More...
 
void SetHeight (double foreshorteningSymbolHeight)
 Sets the foreshortening symbol height
Created in NX10.0.0. More...
 
void SetWidth (double foreshorteningSymbolWidth)
 Sets the foreshortening symbol width
Created in NX10.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
double Width ()
 Returns the foreshortening symbol width
Created in NX10.0.0. 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::ForeshorteningSymbolSettingsBuilder builder
Created in NX10.0.0.


Member Enumeration Documentation

Represents foreshortening symbol method type.

Enumerator
MethodTypeWidthAndAngle 

width and angle

MethodTypeWidthAndHeight 

width and height

Represents foreshortening symbol type.

Enumerator
SymbolTypeRegular 

regular

SymbolTypeStretched 

stretched

Member Function Documentation

double NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::Angle ( )

Returns the foreshortening symbol angle
Created in NX10.0.0.



License requirements : None

NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::MethodType NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::ForeshorteningSymbolMethodType ( )

Returns the foreshortening symbol method
Created in NX10.0.0.



License requirements : None

NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SymbolType NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::ForeshorteningSymbolType ( )

Returns the foreshortening symbol type
Created in NX10.0.0.



License requirements : None

double NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::Height ( )

Returns the foreshortening symbol height
Created in NX10.0.0.



License requirements : None

void NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SetAngle ( double  foreshorteningSymbolAngle)

Sets the foreshortening symbol angle
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foreshorteningSymbolAngleforeshorteningsymbolangle
void NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SetForeshorteningSymbolMethodType ( NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::MethodType  foreshorteningSymbolMethod)

Sets the foreshortening symbol method
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foreshorteningSymbolMethodforeshorteningsymbolmethod
void NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SetForeshorteningSymbolType ( NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SymbolType  foreshorteningSymbolType)

Sets the foreshortening symbol type
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foreshorteningSymbolTypeforeshorteningsymboltype
void NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SetHeight ( double  foreshorteningSymbolHeight)

Sets the foreshortening symbol height
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foreshorteningSymbolHeightforeshorteningsymbolheight
void NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::SetWidth ( double  foreshorteningSymbolWidth)

Sets the foreshortening symbol width
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
foreshorteningSymbolWidthforeshorteningsymbolwidth
virtual bool NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::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.

double NXOpen::Annotations::ForeshorteningSymbolSettingsBuilder::Width ( )

Returns the foreshortening symbol width
Created in NX10.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.