NXOpen::Drawings::ViewBreakBuilder Class Reference

Represents a Drawings::ViewBreakBuilder
This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Drawings::ViewBreakBuilder:

Public Types
enum	Viewbreaklinestyle {   ViewbreaklinestyleSimple, ViewbreaklinestyleStraight, ViewbreaklinestyleSawtooth, ViewbreaklinestyleLongBreak,   ViewbreaklinestyleTubular, ViewbreaklinestyleSolidTubular, ViewbreaklinestyleSolidRod, ViewbreaklinestyleJigsaw,   ViewbreaklinestyleWood, ViewbreaklinestyleCopyCurve, ViewbreaklinestyleTemplateCurve }
	style for view break line More...

Public Member Functions
double	BreakGap ()
	Returns the break gap Created in NX9.0.0.
double	BreakLineAmplitude ()
	Returns the break line amplitude Created in NX9.0.0.
NXOpen::LineColorFontWidthBuilder *	BreakLineColorWidth ()
	Returns the break line color width Created in NX9.0.0.
double	BreakLineExtension ()
	Returns the break line extension Created in NX9.0.0.
NXOpen::Drawings::ViewBreakBuilder::Viewbreaklinestyle	BreakLineStyle ()
	Returns the break line style Created in NX9.0.0.
bool	PropagateViewBreak ()
	Returns the propagate view break Created in NX9.0.0.
void	SetBreakGap (double breakGap)
	Sets the break gap Created in NX9.0.0.
void	SetBreakLineAmplitude (double breakLineAmplitude)
	Sets the break line amplitude Created in NX9.0.0.
void	SetBreakLineExtension (double breakLineExtension)
	Sets the break line extension Created in NX9.0.0.
void	SetBreakLineStyle (NXOpen::Drawings::ViewBreakBuilder::Viewbreaklinestyle breakLineStyle)
	Sets the break line style Created in NX9.0.0.
void	SetPropagateViewBreak (bool propagateViewBreak)
	Sets the propagate view break Created in NX9.0.0.
void	SetShowBreakLines (bool showBreakLines)
	Sets the show break lines Created in NX9.0.0.
bool	ShowBreakLines ()
	Returns the show break lines Created in NX9.0.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Drawings::ViewBreakBuilder
This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::ViewBreakBuilder::Viewbreaklinestyle

style for view break line

Enumerator:

ViewbreaklinestyleSimple	simple
ViewbreaklinestyleStraight	straight
ViewbreaklinestyleSawtooth	sawtooth
ViewbreaklinestyleLongBreak	long break
ViewbreaklinestyleTubular	tubular
ViewbreaklinestyleSolidTubular	solid tubular
ViewbreaklinestyleSolidRod	solid rod
ViewbreaklinestyleJigsaw	jigsaw
ViewbreaklinestyleWood	wood
ViewbreaklinestyleCopyCurve	copy curve
ViewbreaklinestyleTemplateCurve	template curve

Member Function Documentation

double NXOpen::Drawings::ViewBreakBuilder::BreakGap

(

)

Returns the break gap
Created in NX9.0.0.

License requirements : None

double NXOpen::Drawings::ViewBreakBuilder::BreakLineAmplitude

(

)

Returns the break line amplitude
Created in NX9.0.0.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Drawings::ViewBreakBuilder::BreakLineColorWidth

(

)

Returns the break line color width
Created in NX9.0.0.

License requirements : None

double NXOpen::Drawings::ViewBreakBuilder::BreakLineExtension

(

)

Returns the break line extension
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::ViewBreakBuilder::Viewbreaklinestyle NXOpen::Drawings::ViewBreakBuilder::BreakLineStyle

(

)

Returns the break line style
Created in NX9.0.0.

License requirements : None

bool NXOpen::Drawings::ViewBreakBuilder::PropagateViewBreak

(

)

Returns the propagate view break
Created in NX9.0.0.

License requirements : None

void NXOpen::Drawings::ViewBreakBuilder::SetBreakGap

(

double

breakGap

)

Sets the break gap
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

breakGap

breakgap

void NXOpen::Drawings::ViewBreakBuilder::SetBreakLineAmplitude

(

double

breakLineAmplitude

)

Sets the break line amplitude
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

breakLineAmplitude

breaklineamplitude

void NXOpen::Drawings::ViewBreakBuilder::SetBreakLineExtension

(

double

breakLineExtension

)

Sets the break line extension
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

breakLineExtension

breaklineextension

void NXOpen::Drawings::ViewBreakBuilder::SetBreakLineStyle

(

NXOpen::Drawings::ViewBreakBuilder::Viewbreaklinestyle

breakLineStyle

)

Sets the break line style
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

breakLineStyle

breaklinestyle

void NXOpen::Drawings::ViewBreakBuilder::SetPropagateViewBreak

(

bool

propagateViewBreak

)

Sets the propagate view break
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

propagateViewBreak

propagateviewbreak

void NXOpen::Drawings::ViewBreakBuilder::SetShowBreakLines

(

bool

showBreakLines

)

Sets the show break lines
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

showBreakLines

showbreaklines

bool NXOpen::Drawings::ViewBreakBuilder::ShowBreakLines

(

)

Returns the show break lines
Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Drawings::ViewBreakBuilder::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:

• Drawings_ViewBreakBuilder.hxx