NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Drawings::BrokenViewBuilder Class Reference

This class is used to construct the broken view Builder
To create a new instance of this class, use Drawings::DraftingViewCollection::CreateBrokenViewBuilder
Default values. More...

Inheritance diagram for NXOpen::Drawings::BrokenViewBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  BreakLineStyle {
  BreakLineStyleSimple, BreakLineStyleStraight, BreakLineStyleSawtooth, BreakLineStyleLongBreak,
  BreakLineStyleTubular, BreakLineStyleSolidTubular, BreakLineStyleSolidRod, BreakLineStyleJigsaw,
  BreakLineStyleWood, BreakLineStyleCopyCurve, BreakLineStyleTemplateCurve
}
 Break Line Type. More...
enum  HorizontalBreakSide { HorizontalBreakSideLeftEnd, HorizontalBreakSideRightEnd }
 Which side to remove in case of vertical single-sided break. More...
enum  LineWidth { LineWidthThin, LineWidthMedium, LineWidthThick }
 Line Width. More...
enum  TypeBreak { TypeBreakRegular, TypeBreakSingleSided }
 Specifies whether the break is two-sided (regular) or one-sided. More...
enum  TypeDirection { TypeDirectionParallel, TypeDirectionPerpendicular, TypeDirectionVector }
 Direction Enum. More...
enum  VerticalBreakSide { VerticalBreakSideTopEnd, VerticalBreakSideBottomEnd }
 Which side to remove in case of horizontal single-sided break. More...

Public Member Functions

NXOpen::ExpressionAmplitude ()
 Returns the break line amplitude
Created in NX7.5.0.
NXOpen::PointBreakLine1Anchor ()
 Returns the object specifying the position of the first break line
Created in NX7.5.0.
NXOpen::PointBreakLine1ModelAnchor ()
 Returns the object specifying the position of the first break line
Created in NX7.5.0.
NXOpen::ExpressionBreakLine1Offset ()
 Returns the offset from the object locating the first break line
Created in NX7.5.0.
NXOpen::PointBreakLine2Anchor ()
 Returns the object specifying the position of the second break line.
NXOpen::PointBreakLine2ModelAnchor ()
 Returns the object specifying the position of the second break line.
NXOpen::ExpressionBreakLine2Offset ()
 Returns the offset from the object locating the second break line.
NXOpen::Drawings::BrokenViewBuilder::BreakLineStyle BreakLineType ()
 Returns the break line type
Created in NX7.5.0.
NXOpen::Drawings::BrokenViewBuilder::TypeBreak BreakType ()
 Returns the break type
Created in NX7.5.0.
bool BreakVisibility ()
 Returns the view break visibilitity
Created in NX8.0.0.
NXOpen::NXColorColor ()
 Returns the break line color
Created in NX7.5.0.
NXOpen::Annotations::HatchFillSettingsBuilderCrossHatch ()
 Returns the HatchFillSetting
Created in NX7.5.0.
NXOpen::Drawings::BrokenViewBuilder::TypeDirection DirectionType ()
 Returns the direction type
Created in NX7.5.0.
NXOpen::DirectionDirectionVector ()
 Returns the direction vector.
NXOpen::ScCollectorExistingCurve ()
 Returns the curve to use as existing curve
Created in NX7.5.0.
NXOpen::ExpressionExtension1 ()
 Returns the break line extension (top/right) beyond geometry
Created in NX7.5.0.
NXOpen::ExpressionExtension2 ()
 Returns the break line extension (bottom/left) beyond geometry
Created in NX7.5.0.
NXOpen::ExpressionGap ()
 Returns the gap on the sheet between the two break lines
Created in NX7.5.0.
bool IsBreakLine1Associative ()
 Returns the associative positionning of the first break line
Created in NX7.5.0.
bool IsBreakLine2Associative ()
 Returns the associative positionning of the second break line.
NXOpen::Drawings::SelectDraftingViewMasterView ()
 Returns the master view
Created in NX7.5.0.
int Repetition ()
 Returns the repetition of the break line pattern
Created in NX7.5.0.
void SetBreakLine1Anchor (NXOpen::Point *anchor1)
 Sets the object specifying the position of the first break line
Created in NX7.5.0.
void SetBreakLine1Associative (bool isBreakLine1Associative)
 Sets the associative positionning of the first break line
Created in NX7.5.0.
void SetBreakLine1ModelAnchor (NXOpen::Point *anchor1)
 Sets the object specifying the position of the first break line
Created in NX7.5.0.
void SetBreakLine2Anchor (NXOpen::Point *anchor2)
 Sets the object specifying the position of the second break line.
void SetBreakLine2Associative (bool isBreakLine2Associative)
 Sets the associative positionning of the second break line.
void SetBreakLine2ModelAnchor (NXOpen::Point *anchor2)
 Sets the object specifying the position of the second break line.
void SetBreakLineType (NXOpen::Drawings::BrokenViewBuilder::BreakLineStyle lineType)
 Sets the break line type
Created in NX7.5.0.
void SetBreakType (NXOpen::Drawings::BrokenViewBuilder::TypeBreak breakType)
 Sets the break type
Created in NX7.5.0.
void SetBreakVisibility (bool visibilitity)
 Sets the view break visibilitity
Created in NX8.0.0.
void SetColor (NXOpen::NXColor *color)
 Sets the break line color
Created in NX7.5.0.
void SetDirectionType (NXOpen::Drawings::BrokenViewBuilder::TypeDirection directionType)
 Sets the direction type
Created in NX7.5.0.
void SetDirectionVector (NXOpen::Direction *directionVector)
 Sets the direction vector.
void SetRepetition (int repetition)
 Sets the repetition of the break line pattern
Created in NX7.5.0.
void SetSuppress (bool suppress)
 Sets the view break suppress status
Created in NX7.5.0.
void SetWidth (NXOpen::Drawings::BrokenViewBuilder::LineWidth width)
 Sets the curve width of the break line
Created in NX7.5.0.
bool Suppress ()
 Returns the view break suppress status
Created in NX8.0.0.
NXOpen::Drawings::BrokenViewBuilder::LineWidth Width ()
 Returns the curve width of the break line
Created in NX7.5.0.

Detailed Description

This class is used to construct the broken view Builder
To create a new instance of this class, use Drawings::DraftingViewCollection::CreateBrokenViewBuilder
Default values.

Property Value

Amplitude.Value

5 (millimeters part), 0.25 (inches part)

BreakLine1Offset.Value

0 (millimeters part), 0 (inches part)

BreakLine2Offset.Value

0 (millimeters part), 0 (inches part)

BreakLineType

Simple

BreakType

Regular

DirectionType

Vector

Extension1.Value

0 (millimeters part), 0 (inches part)

Extension2.Value

0 (millimeters part), 0 (inches part)

Gap.Value

10 (millimeters part), 0.25 (inches part)

IsBreakLine1Associative

1

IsBreakLine2Associative

1

Repetition

1

Width

Medium


Created in NX7.5.0.


Member Enumeration Documentation

Break Line Type.

Enumerator:
BreakLineStyleSimple 

Simple.

BreakLineStyleStraight 

Straight.

BreakLineStyleSawtooth 

Sawtooth.

BreakLineStyleLongBreak 

LongBreak.

BreakLineStyleTubular 

Tubular.

BreakLineStyleSolidTubular 

Solid Tubular.

BreakLineStyleSolidRod 

Solid Rod.

BreakLineStyleJigsaw 

Jigsaw.

BreakLineStyleWood 

Wood.

BreakLineStyleCopyCurve 

Copy of the existing curve.

BreakLineStyleTemplateCurve 

Template, based on the existing curve.

Which side to remove in case of vertical single-sided break.

Enumerator:
HorizontalBreakSideLeftEnd 

Hide Left side.

HorizontalBreakSideRightEnd 

Hide Right side.

Line Width.

Enumerator:
LineWidthThin 

Thin.

LineWidthMedium 

Medium.

LineWidthThick 

Thick.

Specifies whether the break is two-sided (regular) or one-sided.

Enumerator:
TypeBreakRegular 

Regular Break.

TypeBreakSingleSided 

SingleSiled Break.

Direction Enum.

Enumerator:
TypeDirectionParallel 

Parallel.

TypeDirectionPerpendicular 

Perpendicular.

TypeDirectionVector 

Specified by Vector.

Which side to remove in case of horizontal single-sided break.

Enumerator:
VerticalBreakSideTopEnd 

Hide Top side.

VerticalBreakSideBottomEnd 

Hide Bottom side.


Member Function Documentation

Returns the break line amplitude
Created in NX7.5.0.



License requirements : None

Returns the object specifying the position of the first break line
Created in NX7.5.0.



License requirements : None

Returns the object specifying the position of the first break line
Created in NX7.5.0.



License requirements : None

Returns the offset from the object locating the first break line
Created in NX7.5.0.



License requirements : None

Returns the object specifying the position of the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Returns the object specifying the position of the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Returns the offset from the object locating the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Returns the break line type
Created in NX7.5.0.



License requirements : None

Returns the break type
Created in NX7.5.0.



License requirements : None

Returns the view break visibilitity
Created in NX8.0.0.



License requirements : None

Returns the break line color
Created in NX7.5.0.



License requirements : None

Returns the HatchFillSetting
Created in NX7.5.0.



License requirements : None

Returns the direction type
Created in NX7.5.0.



License requirements : None

Returns the direction vector.

For Drawings::BrokenViewBuilder::TypeDirectionVector .
Created in NX7.5.0.

License requirements : None

Returns the curve to use as existing curve
Created in NX7.5.0.



License requirements : None

Returns the break line extension (top/right) beyond geometry
Created in NX7.5.0.



License requirements : None

Returns the break line extension (bottom/left) beyond geometry
Created in NX7.5.0.



License requirements : None

Returns the gap on the sheet between the two break lines
Created in NX7.5.0.



License requirements : None

Returns the associative positionning of the first break line
Created in NX7.5.0.



License requirements : None

Returns the associative positionning of the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Returns the master view
Created in NX7.5.0.



License requirements : None

Returns the repetition of the break line pattern
Created in NX7.5.0.



License requirements : None

Sets the object specifying the position of the first break line
Created in NX7.5.0.



License requirements : None

Parameters:
anchor1anchor1
void NXOpen::Drawings::BrokenViewBuilder::SetBreakLine1Associative ( bool  isBreakLine1Associative)

Sets the associative positionning of the first break line
Created in NX7.5.0.



License requirements : None

Parameters:
isBreakLine1Associativeisbreakline1associative

Sets the object specifying the position of the first break line
Created in NX7.5.0.



License requirements : None

Parameters:
anchor1anchor1

Sets the object specifying the position of the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Parameters:
anchor2anchor2
void NXOpen::Drawings::BrokenViewBuilder::SetBreakLine2Associative ( bool  isBreakLine2Associative)

Sets the associative positionning of the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Parameters:
isBreakLine2Associativeisbreakline2associative

Sets the object specifying the position of the second break line.

For Drawings::BrokenViewBuilder::TypeBreakRegular only
Created in NX7.5.0.

License requirements : None

Parameters:
anchor2anchor2

Sets the break line type
Created in NX7.5.0.



License requirements : None

Parameters:
lineTypelinetype

Sets the break type
Created in NX7.5.0.



License requirements : None

Parameters:
breakTypebreaktype

Sets the view break visibilitity
Created in NX8.0.0.



License requirements : None

Parameters:
visibilitityvisibilitity

Sets the break line color
Created in NX7.5.0.



License requirements : None

Parameters:
colorcolor

Sets the direction type
Created in NX7.5.0.



License requirements : None

Parameters:
directionTypedirectiontype

Sets the direction vector.

For Drawings::BrokenViewBuilder::TypeDirectionVector .
Created in NX7.5.0.

License requirements : None

Parameters:
directionVectordirectionvector

Sets the repetition of the break line pattern
Created in NX7.5.0.



License requirements : None

Parameters:
repetitionrepetition

Sets the view break suppress status
Created in NX7.5.0.



License requirements : None

Parameters:
suppresssuppress

Sets the curve width of the break line
Created in NX7.5.0.



License requirements : None

Parameters:
widthwidth

Returns the view break suppress status
Created in NX8.0.0.



License requirements : None

Returns the curve width of the break line
Created in NX7.5.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.