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

Represents a Builder for Centerline Settings. More...

Inheritance diagram for NXOpen::Annotations::CenterlineSettingsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::Centerline2dSettingsBuilder NXOpen::Annotations::Centerline3dSettingsBuilder NXOpen::Annotations::CenterMarkSettingsBuilder NXOpen::Annotations::CircleCenterlineSettingsBuilder NXOpen::Annotations::SymmetricalCenterlineSettingsBuilder

Public Types

enum  CenterlineThickness {
  CenterlineThicknessThin, CenterlineThicknessNormal, CenterlineThicknessThick, CenterlineThicknessOne = 6,
  CenterlineThicknessTwo, CenterlineThicknessThree, CenterlineThicknessFour, CenterlineThicknessFive,
  CenterlineThicknessSix, CenterlineThicknessSeven, CenterlineThicknessEight, CenterlineThicknessNine
}
 the types of centerline thickness More...
 

Public Member Functions

NXOpen::NXColorColor ()
 Returns the color of centerline
Created in NX6.0.0. More...
 
double Gap ()
 Returns the gap parameter for centeline
Created in NX6.0.0. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color of centerline
Created in NX6.0.0. More...
 
void SetGap (double gap)
 Sets the gap parameter for centeline
Created in NX6.0.0. More...
 
void SetWidth (NXOpen::Annotations::CenterlineSettingsBuilder::CenterlineThickness width)
 Sets the width of centerline
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::Annotations::CenterlineSettingsBuilder::CenterlineThickness Width ()
 Returns the width of centerline
Created in NX6.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 Builder for Centerline Settings.

This contains settings common to all centerlines
Created in NX6.0.0.

Member Enumeration Documentation

the types of centerline thickness

Enumerator
CenterlineThicknessThin 

Thin.

CenterlineThicknessNormal 

Normal.

CenterlineThicknessThick 

Thick.

CenterlineThicknessOne 

Width One.

CenterlineThicknessTwo 

Width Two.

CenterlineThicknessThree 

Width Three.

CenterlineThicknessFour 

Width Four.

CenterlineThicknessFive 

Width Five.

CenterlineThicknessSix 

Width Six.

CenterlineThicknessSeven 

Width Seven.

CenterlineThicknessEight 

Width Eight.

CenterlineThicknessNine 

Width Nine.

Member Function Documentation

NXOpen::NXColor* NXOpen::Annotations::CenterlineSettingsBuilder::Color ( )

Returns the color of centerline
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::CenterlineSettingsBuilder::Gap ( )

Returns the gap parameter for centeline
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::CenterlineSettingsBuilder::SetColor ( NXOpen::NXColor color)

Sets the color of centerline
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
colorcolor
void NXOpen::Annotations::CenterlineSettingsBuilder::SetGap ( double  gap)

Sets the gap parameter for centeline
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
gapgap
void NXOpen::Annotations::CenterlineSettingsBuilder::SetWidth ( NXOpen::Annotations::CenterlineSettingsBuilder::CenterlineThickness  width)

Sets the width of centerline
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
widthwidth
virtual bool NXOpen::Annotations::CenterlineSettingsBuilder::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.

NXOpen::Annotations::CenterlineSettingsBuilder::CenterlineThickness NXOpen::Annotations::CenterlineSettingsBuilder::Width ( )

Returns the width of centerline
Created in NX6.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.