NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::PartDrafting Class Reference

Represents the set of drafting preferences applicable to part
To obtain an instance of this class, refer to Preferences::PartPreferences

Created in NX3.0.0. More...

List of all members.

Public Types

enum  BreakLineStyle {
  BreakLineStyleExisting, BreakLineStyleSimple, BreakLineStyleStraight, BreakLineStyleSawtooth,
  BreakLineStyleLongBreak, BreakLineStyleTubular, BreakLineStyleSolidTubular, BreakLineStyleSolidRod,
  BreakLineStyleJigsaw, BreakLineStyleWood
}
 Describes the available break line style. More...
enum  FontType {
  FontTypeOriginal, FontTypeInvisible, FontTypeSolid, FontTypeDashed,
  FontTypePhantom, FontTypeCenterline, FontTypeDotted, FontTypeLongDashed,
  FontTypeDottedDashed
}
 Describes the available font types. More...
enum  ViewStyleType { ViewStyleTypeBorder, ViewStyleTypeWireframe, ViewStyleTypeHiddenWireframe, ViewStyleTypeShaded }
 Describes the available view style types for preview. More...
enum  WidthType { WidthTypeOriginal, WidthTypeThin, WidthTypeNormal, WidthTypeThick }
 Describes the available width types. More...

Public Member Functions

NXOpen::NXColorActiveViewColor ()
 Returns the drafting active view color.
int BorderColor ()
 Returns the drafting view border color.
double BreakLineAmplitude ()
 Returns the break line amplitude.
NXOpen::NXColorBreakLineColor ()
 Returns the break line color.
double BreakLineExtension ()
 Returns
Created in NX7.5.0.
double BreakLineGap ()
 Returns the break line gap.
bool BreakLinesVisibility ()
 Returns the break lines visibility.
NXOpen::Preferences::PartDrafting::BreakLineStyle BreakLineType ()
 Returns the break line type.
int BreakLineWidth ()
 Returns the break line width.
int Color ()
 Returns the color of the retained Annotations::Annotation objects.
bool DelayUpdateOnCreation ()
 Returns the flag indicating whether the newly created views should update immediately even when the view update is delayed.
bool DelayViewUpdate ()
 Returns the flag indicating whether to delay update of the drafting views during system initiated drawing updates
Created in NX3.0.0.
NXString Delimiter ()
 Returns the delimiter
Created in NX8.0.0.
bool DisplayBorders ()
 Returns the flag indicating whether to display borders around drafting views, when selected
Created in NX3.0.0.
NXOpen::Preferences::PartDrafting::FontType Font ()
 Returns the line font of the retained Annotations::Annotation objects
Created in NX3.0.0.
int FrameBarPrecision ()
 Returns the frame bar precision.
int FrameBarTicDirection ()
 Returns the frame bar tic direction.
NXString InitialSecondaryNumber ()
 Returns the initial secondary number
Created in NX8.0.0.
NXString InitialSheetNumber ()
 Returns the initial sheet number
Created in NX8.0.0.
bool LineAntialiasing ()
 Returns the flag indicating whether to display drawing using line antialiasing.
bool PropagateBreakLines ()
 Returns the propagation of view break.
bool RetainAnnotations ()
 Returns the flag indicating whether to retain Annotations::Annotation objects when the geometry they are attached to is deleted.
void SetActiveViewColor (NXOpen::NXColor *borderColor)
 Sets the drafting active view color.
void SetBorderColor (int borderColor)
 Sets the drafting view border color.
void SetBreakLineAmplitude (double amplitude)
 Sets the break line amplitude.
void SetBreakLineColor (NXOpen::NXColor *color)
 Sets the break line color.
void SetBreakLineExtension (double extension)
 Sets
Created in NX7.5.0.
void SetBreakLineGap (double gap)
 Sets the break line gap.
void SetBreakLinesVisibility (bool isVisible)
 Sets the break lines visibility.
void SetBreakLineType (NXOpen::Preferences::PartDrafting::BreakLineStyle lineType)
 Sets the break line type.
void SetBreakLineWidth (int width)
 Sets the break line width.
void SetColor (int color)
 Sets the color of the retained Annotations::Annotation objects.
void SetDelayUpdateOnCreation (bool isDelayUpdateOnCreationOn)
 Sets the flag indicating whether the newly created views should update immediately even when the view update is delayed.
void SetDelayViewUpdate (bool isDelayViewUpdateOn)
 Sets the flag indicating whether to delay update of the drafting views during system initiated drawing updates
Created in NX3.0.0.
void SetDelimiter (const NXString &delimiter)
 Sets the delimiter
Created in NX8.0.0.
void SetDisplayBorders (bool displayBorders)
 Sets the flag indicating whether to display borders around drafting views, when selected
Created in NX3.0.0.
void SetFont (NXOpen::Preferences::PartDrafting::FontType font)
 Sets the line font of the retained Annotations::Annotation objects
Created in NX3.0.0.
void SetFrameBarPrecision (int precision)
 Sets the frame bar precision.
void SetFrameBarTicDirection (int ticDirection)
 Sets the frame bar tic direction.
void SetInitialSecondaryNumber (const NXString &initialSecondaryNumber)
 Sets the initial secondary number
Created in NX8.0.0.
void SetInitialSheetNumber (const NXString &initialSheetNumber)
 Sets the initial sheet number
Created in NX8.0.0.
void SetLineAntialiasing (bool lineAntialiasing)
 Sets the flag indicating whether to display drawing using line antialiasing.
void SetPropagateBreakLines (bool doesPropagate)
 Sets the propagation of view break.
void SetRetainAnnotations (bool retainAnnotations)
 Sets the flag indicating whether to retain Annotations::Annotation objects when the geometry they are attached to is deleted.
void SetShowFacetEdges (bool showFacetEdges)
 Sets the flag indicating whether to display facet edges in shaded member views.
void SetTranslucency (bool translucency)
 Sets the flag indicating whether to display solids in shaded member views with translucency.
void SetVersionObjects (bool versonObjects)
 Sets the drafting version objects setting when updating drafting objects and member views
Created in NX4.0.0.
void SetViewStyle (NXOpen::Preferences::PartDrafting::ViewStyleType viewStyle)
 Sets the drafting view style type for preview when placing the view
Created in NX3.0.0.
void SetViewTracking (bool viewTracking)
 Sets the flag indicating whether to track a drafting view during preview when placing the view.
void SetWidth (NXOpen::Preferences::PartDrafting::WidthType width)
 Sets the line width of the retained Annotations::Annotation objects
Created in NX3.0.0.
bool ShowFacetEdges ()
 Returns the flag indicating whether to display facet edges in shaded member views.
tag_t Tag () const
 Returns the tag of this object.
bool Translucency ()
 Returns the flag indicating whether to display solids in shaded member views with translucency.
bool VersionObjects ()
 Returns the drafting version objects setting when updating drafting objects and member views
Created in NX4.0.0.
NXOpen::Preferences::PartDrafting::ViewStyleType ViewStyle ()
 Returns the drafting view style type for preview when placing the view
Created in NX3.0.0.
bool ViewTracking ()
 Returns the flag indicating whether to track a drafting view during preview when placing the view.
NXOpen::Preferences::PartDrafting::WidthType Width ()
 Returns the line width of the retained Annotations::Annotation objects
Created in NX3.0.0.

Detailed Description

Represents the set of drafting preferences applicable to part
To obtain an instance of this class, refer to Preferences::PartPreferences

Created in NX3.0.0.



Member Enumeration Documentation

Describes the available break line style.

Enumerator:
BreakLineStyleExisting 

Existing Curve.

BreakLineStyleSimple 

Simple.

BreakLineStyleStraight 

Straight.

BreakLineStyleSawtooth 

Sawtooth.

BreakLineStyleLongBreak 

LongBreak.

BreakLineStyleTubular 

Tubular.

BreakLineStyleSolidTubular 

Solid Tubular.

BreakLineStyleSolidRod 

Solid Rod.

BreakLineStyleJigsaw 

Jigsaw.

BreakLineStyleWood 

Wood.

Describes the available font types.

Enumerator:
FontTypeOriginal 

Original.

FontTypeInvisible 

Invisible.

FontTypeSolid 

Solid.

FontTypeDashed 

Dashed.

FontTypePhantom 

Phantom.

FontTypeCenterline 

CenterLine.

FontTypeDotted 

Dotted.

FontTypeLongDashed 

Long Dashed.

FontTypeDottedDashed 

Dotted Dashed.

Describes the available view style types for preview.

Enumerator:
ViewStyleTypeBorder 

Border.

ViewStyleTypeWireframe 

Wireframe.

ViewStyleTypeHiddenWireframe 

Hidden Wireframe.

ViewStyleTypeShaded 

Shaded.

Describes the available width types.

Enumerator:
WidthTypeOriginal 

Original.

WidthTypeThin 

Thin.

WidthTypeNormal 

Normal.

WidthTypeThick 

Thick.


Member Function Documentation

Returns the drafting active view color.


Created in NX6.0.0.

License requirements : None

Returns the drafting view border color.

The value should be between 1 and 216.
Created in NX3.0.0.

License requirements : None

Returns the break line amplitude.


Created in NX7.5.0.

License requirements : None

Returns the break line color.


Created in NX7.5.0.

License requirements : None

Returns
Created in NX7.5.0.



License requirements : None

Returns the break line gap.


Created in NX7.5.0.

License requirements : None

Returns the break lines visibility.


Created in NX8.0.0.

License requirements : None

Returns the break line type.


Created in NX7.5.0.

License requirements : None

Returns the break line width.


Created in NX7.5.0.

License requirements : None

Returns the color of the retained Annotations::Annotation objects.

The value should be between 1 and 216.
Created in NX3.0.0.

License requirements : None

Returns the flag indicating whether the newly created views should update immediately even when the view update is delayed.


Created in NX3.0.0.

License requirements : None

Returns the flag indicating whether to delay update of the drafting views during system initiated drawing updates
Created in NX3.0.0.



License requirements : None

Returns the delimiter
Created in NX8.0.0.



License requirements : None

Returns the flag indicating whether to display borders around drafting views, when selected
Created in NX3.0.0.



License requirements : None

Returns the line font of the retained Annotations::Annotation objects
Created in NX3.0.0.



License requirements : None

Returns the frame bar precision.


Created in NX8.0.0.

License requirements : None

Returns the frame bar tic direction.


Created in NX8.0.0.

License requirements : None

Returns the initial secondary number
Created in NX8.0.0.



License requirements : None

Returns the initial sheet number
Created in NX8.0.0.



License requirements : None

Returns the flag indicating whether to display drawing using line antialiasing.


Created in NX5.0.1.

License requirements : None

Returns the propagation of view break.


Created in NX7.5.0.

License requirements : None

Returns the flag indicating whether to retain Annotations::Annotation objects when the geometry they are attached to is deleted.

When false, the Annotations::Annotation objects get deleted with the geometry.
Created in NX3.0.0.

License requirements : None

Sets the drafting active view color.


Created in NX6.0.0.

License requirements : None

Parameters:
borderColorborder color

Sets the drafting view border color.

The value should be between 1 and 216.
Created in NX3.0.0.

License requirements : None

Parameters:
borderColorborder color

Sets the break line amplitude.


Created in NX7.5.0.

License requirements : None

Parameters:
amplitudeamplitude

Sets the break line color.


Created in NX7.5.0.

License requirements : None

Parameters:
colorcolor

Sets
Created in NX7.5.0.



License requirements : None

Parameters:
extensionextension

Sets the break line gap.


Created in NX7.5.0.

License requirements : None

Parameters:
gapgap

Sets the break lines visibility.


Created in NX8.0.0.

License requirements : None

Parameters:
isVisibleisvisible

Sets the break line type.


Created in NX7.5.0.

License requirements : None

Parameters:
lineTypeline type

Sets the break line width.


Created in NX7.5.0.

License requirements : None

Parameters:
widthwidth

Sets the color of the retained Annotations::Annotation objects.

The value should be between 1 and 216.
Created in NX3.0.0.

License requirements : None

Parameters:
colorcolor
void NXOpen::Preferences::PartDrafting::SetDelayUpdateOnCreation ( bool  isDelayUpdateOnCreationOn)

Sets the flag indicating whether the newly created views should update immediately even when the view update is delayed.


Created in NX3.0.0.

License requirements : None

Parameters:
isDelayUpdateOnCreationOnisdelayupdateoncreationon
void NXOpen::Preferences::PartDrafting::SetDelayViewUpdate ( bool  isDelayViewUpdateOn)

Sets the flag indicating whether to delay update of the drafting views during system initiated drawing updates
Created in NX3.0.0.



License requirements : None

Parameters:
isDelayViewUpdateOnisdelayviewupdateon

Sets the delimiter
Created in NX8.0.0.



License requirements : None

Parameters:
delimiterdelimiter

Sets the flag indicating whether to display borders around drafting views, when selected
Created in NX3.0.0.



License requirements : None

Parameters:
displayBordersdisplay borders

Sets the line font of the retained Annotations::Annotation objects
Created in NX3.0.0.



License requirements : None

Parameters:
fontfont

Sets the frame bar precision.


Created in NX8.0.0.

License requirements : None

Parameters:
precisionprecision

Sets the frame bar tic direction.


Created in NX8.0.0.

License requirements : None

Parameters:
ticDirectionticdirection

Sets the initial secondary number
Created in NX8.0.0.



License requirements : None

Parameters:
initialSecondaryNumberinitialsecondarynumber

Sets the initial sheet number
Created in NX8.0.0.



License requirements : None

Parameters:
initialSheetNumberinitialsheetnumber

Sets the flag indicating whether to display drawing using line antialiasing.


Created in NX5.0.1.

License requirements : None

Parameters:
lineAntialiasingline antialiasing

Sets the propagation of view break.


Created in NX7.5.0.

License requirements : None

Parameters:
doesPropagatedoespropagate

Sets the flag indicating whether to retain Annotations::Annotation objects when the geometry they are attached to is deleted.

When false, the Annotations::Annotation objects get deleted with the geometry.
Created in NX3.0.0.

License requirements : None

Parameters:
retainAnnotationsretain annotations

Sets the flag indicating whether to display facet edges in shaded member views.


Created in NX5.0.1.

License requirements : None

Parameters:
showFacetEdgesshow facet edges

Sets the flag indicating whether to display solids in shaded member views with translucency.


Created in NX5.0.1.

License requirements : None

Parameters:
translucencytranslucency

Sets the drafting version objects setting when updating drafting objects and member views
Created in NX4.0.0.



License requirements : None

Parameters:
versonObjectsverson objects

Sets the drafting view style type for preview when placing the view
Created in NX3.0.0.



License requirements : None

Parameters:
viewStyleview style

Sets the flag indicating whether to track a drafting view during preview when placing the view.

The cursor is tracked using XC/YC coordinates.
Created in NX3.0.0.

License requirements : None

Parameters:
viewTrackingview tracking

Sets the line width of the retained Annotations::Annotation objects
Created in NX3.0.0.



License requirements : None

Parameters:
widthwidth

Returns the flag indicating whether to display facet edges in shaded member views.


Created in NX5.0.1.

License requirements : None

Returns the tag of this object.

Returns the flag indicating whether to display solids in shaded member views with translucency.


Created in NX5.0.1.

License requirements : None

Returns the drafting version objects setting when updating drafting objects and member views
Created in NX4.0.0.



License requirements : None

Returns the drafting view style type for preview when placing the view
Created in NX3.0.0.



License requirements : None

Returns the flag indicating whether to track a drafting view during preview when placing the view.

The cursor is tracked using XC/YC coordinates.
Created in NX3.0.0.

License requirements : None

Returns the line width of the retained Annotations::Annotation objects
Created in NX3.0.0.



License requirements : None


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