CuttingPlaneSymbolBuilder Class

class NXOpen.Annotations.CuttingPlaneSymbolBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Annotations.CuttingPlaneSymbolBuilder

This is a sub-builder class and cannot be directly instantiated

New in version NX9.0.0.

Properties

Property	Description
ArrowDirection	Returns or sets the Cutting Plane Symbol Arrow Direction relative to plane
ArrowLength	Returns or sets the Cutting Plane Symbol Arrow Length
Color	Returns or sets the color of the Cutting Plane Symbol
CuttingPlaneSymbolText	Returns or sets the Cutting Plane Symbol text
DisplayCuttingPlaneSymbol	Returns or sets the display cutting plane symbol
Font	Returns the font
ShadedPlane	Returns or sets the shaded plane
Style	Returns the Cutting Plane Symbol Style
Tag	Returns the Tag for this object.
TextPlaneRelativeToArrow	Returns or sets the text plane relative to arrow
UseTwoArrows	Returns or sets the use two arrows
ViewNameFormat	Returns or sets the name view from symbol

Methods

Method	Description
AlternateArrow	The Cutting Plane Symbol Alternate Arrow
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

CuttingPlaneSymbolBuilderArrowDirectionOption Enumeration	Represents position of the arrow direction relative to cutting plane
CuttingPlaneSymbolBuilderTextPlaneRelativeArrow Enumeration	Represents position of the text relative to the arrow option
CuttingPlaneSymbolBuilderViewNameFormatOption Enumeration	Represents whether the view name is derived from the PMI cutting plane symbol text.

Property Detail

ArrowDirection

CuttingPlaneSymbolBuilder.ArrowDirection

Returns or sets the Cutting Plane Symbol Arrow Direction relative to plane

-------------------------------------

Getter Method

Signature ArrowDirection

Returns: Return type:NXOpen.Annotations.CuttingPlaneSymbolBuilderArrowDirectionOption

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ArrowDirection

Parameters:arrowDirection (NXOpen.Annotations.CuttingPlaneSymbolBuilderArrowDirectionOption) –

New in version NX11.0.0.

License requirements: geometric_tol (“GDT”)

ArrowLength

CuttingPlaneSymbolBuilder.ArrowLength

Returns or sets the Cutting Plane Symbol Arrow Length

-------------------------------------

Getter Method

Signature ArrowLength

Returns: Return type:float

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ArrowLength

Parameters:arrowLength (float) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

Color

CuttingPlaneSymbolBuilder.Color

Returns or sets the color of the Cutting Plane Symbol

-------------------------------------

Getter Method

Signature Color

Returns: Return type:int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Color

Parameters:cuttingPlaneSymbolColor (int) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

CuttingPlaneSymbolText

CuttingPlaneSymbolBuilder.CuttingPlaneSymbolText

Returns or sets the Cutting Plane Symbol text

-------------------------------------

Getter Method

Signature CuttingPlaneSymbolText

Returns: Return type:str

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CuttingPlaneSymbolText

Parameters:cuttingPlaneSymbolName (str) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

DisplayCuttingPlaneSymbol

CuttingPlaneSymbolBuilder.DisplayCuttingPlaneSymbol

Returns or sets the display cutting plane symbol

-------------------------------------

Getter Method

Signature DisplayCuttingPlaneSymbol

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayCuttingPlaneSymbol

Parameters:displayCuttingPlaneSymbol (bool) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

Font

CuttingPlaneSymbolBuilder.Font

Returns the font

-------------------------------------

Getter Method

Signature Font

Returns: Return type:NXOpen.LineFontBuilder

New in version NX9.0.0.

License requirements: None.

ShadedPlane

CuttingPlaneSymbolBuilder.ShadedPlane

Returns or sets the shaded plane

-------------------------------------

Getter Method

Signature ShadedPlane

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShadedPlane

Parameters:shadedPlane (bool) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

Style

CuttingPlaneSymbolBuilder.Style

Returns the Cutting Plane Symbol Style

-------------------------------------

Getter Method

Signature Style

Returns: Return type:NXOpen.Annotations.StyleBuilder

New in version NX9.0.0.

License requirements: None.

TextPlaneRelativeToArrow

CuttingPlaneSymbolBuilder.TextPlaneRelativeToArrow

Returns or sets the text plane relative to arrow

-------------------------------------

Getter Method

Signature TextPlaneRelativeToArrow

Returns: Return type:NXOpen.Annotations.CuttingPlaneSymbolBuilderTextPlaneRelativeArrow

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TextPlaneRelativeToArrow

Parameters:textPlaneRelativeToArrow (NXOpen.Annotations.CuttingPlaneSymbolBuilderTextPlaneRelativeArrow) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

UseTwoArrows

CuttingPlaneSymbolBuilder.UseTwoArrows

Returns or sets the use two arrows

-------------------------------------

Getter Method

Signature UseTwoArrows

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseTwoArrows

Parameters:useTwoArrows (bool) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

ViewNameFormat

CuttingPlaneSymbolBuilder.ViewNameFormat

Returns or sets the name view from symbol

-------------------------------------

Getter Method

Signature ViewNameFormat

Returns: Return type:NXOpen.Annotations.CuttingPlaneSymbolBuilderViewNameFormatOption

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ViewNameFormat

Parameters:viewNameFormat (NXOpen.Annotations.CuttingPlaneSymbolBuilderViewNameFormatOption) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”)

Method Detail

AlternateArrow

CuttingPlaneSymbolBuilder.AlternateArrow

The Cutting Plane Symbol Alternate Arrow

Signature AlternateArrow()

New in version NX9.0.0.

License requirements: None.

Validate

CuttingPlaneSymbolBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.