StandardViewsBuilder Class

class NXOpen.Drawings.StandardViewsBuilder

Bases: NXOpen.Builder

This builder allows the user to create a Drawing View

To create a new instance of this class, use NXOpen.Drawings.DraftingViewCollection.CreateStandardViewsBuilder()

Default values.

Property Value
FirstCorner.AlignmentMethod (deprecated) Infer
FirstCorner.AlignmentOption (deprecated) ToView
LayoutType FrontTopRightIso
MarginBetweenViews 5 (millimeters part), 0.25 (inches part)
MarginToBorder 20 (millimeters part), 0.75 (inches part)
MultipleViewPlacement.OptionType Center
Scale.Denominator 1.0
Scale.Numerator 1.0
Scale.ScaleType Ratio
SecondaryComponents.ObjectType PrimaryGeometry
ViewStyle.ViewStyleGeneral.AngleSetting.Angle.Value 0
ViewStyle.ViewStyleGeneral.AngleSetting.Associative 0
ViewStyle.ViewStyleGeneral.AngleSetting.EvaluationPlane DrawingSheet
ViewStyle.ViewStyleOrientation.HingeLine.ReverseDirection false
ViewStyle.ViewStyleOrientation.HingeLine.VectorOption Inferred
ViewStyle.ViewStyleOrientation.Ovt.AssociativeOrientation 0

New in version NX6.0.1.

Properties

Property Description
Autoscale Returns or sets the autoscale mode for base view creation
Coordinate Returns the center coordinate
FirstCorner Returns the first corner view placement
HiddenObjects Returns the list of objects to not show in the view
LayoutType Returns or sets the Layout type
MarginBetweenViews Returns or sets the margin between views
MarginToBorder Returns or sets the margin to border
MultipleViewPlacement Returns the multiple view placement
NonSectionedObjects Returns the list of objects to not section in the view
Part Returns or sets the part to use for base views
PlacementType Returns or sets the Placement type
Scale Returns the view scale
SecondCorner Returns the second corner view placement
SecondaryComponents Returns the list of secondary objects in the view
Tag Returns the Tag for this object.
ViewPlacement Returns the view placement
ViewStyle Returns the view style
ViewType Returns or sets the view type

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

StandardViewsBuilderPlacement Enumeration The view Layout placement type (deprecated)
StandardViewsBuilderType Enumeration The view Layout type
StandardViewsBuilderView Enumeration The view type to create

Property Detail

Autoscale

StandardViewsBuilder.Autoscale

Returns or sets the autoscale mode for base view creation

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

Getter Method

Signature Autoscale

Returns:returns the auto-scale mode status.
Return type:bool

New in version NX6.0.2.

License requirements: None.

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

Setter Method

Signature Autoscale

Parameters:autoScale (bool) – sets the auto-scale mode.

New in version NX6.0.2.

License requirements: nx_layout (“NX Layout”)

Coordinate

StandardViewsBuilder.Coordinate

Returns the center coordinate

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

Getter Method

Signature Coordinate

Returns:
Return type:NXOpen.Drawings.ViewCenterCoordinateBuilder

New in version NX6.0.1.

License requirements: None.

FirstCorner

StandardViewsBuilder.FirstCorner

Returns the first corner view placement

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

Getter Method

Signature FirstCorner

Returns:
Return type:NXOpen.Drawings.ViewPlacementBuilder

New in version NX6.0.1.

Deprecated since version NX6.0.2: Use the first corner of the multiple view placemnent builder instead

License requirements: None.

HiddenObjects

StandardViewsBuilder.HiddenObjects

Returns the list of objects to not show in the view

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

Getter Method

Signature HiddenObjects

Returns:
Return type:NXOpen.Drawings.HiddenObjectsBuilder

New in version NX6.0.2.

License requirements: None.

LayoutType

StandardViewsBuilder.LayoutType

Returns or sets the Layout type

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

Getter Method

Signature LayoutType

Returns:returns the layout type.
Return type:NXOpen.Drawings.StandardViewsBuilderType

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature LayoutType

Parameters:type (NXOpen.Drawings.StandardViewsBuilderType) – sets the layout type.

New in version NX6.0.1.

License requirements: nx_layout (“NX Layout”)

MarginBetweenViews

StandardViewsBuilder.MarginBetweenViews

Returns or sets the margin between views

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

Getter Method

Signature MarginBetweenViews

Returns:returns the margin between views.
Return type:float

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature MarginBetweenViews

Parameters:marginBetweenViews (float) – sets the margin between views.

New in version NX6.0.1.

License requirements: nx_layout (“NX Layout”)

MarginToBorder

StandardViewsBuilder.MarginToBorder

Returns or sets the margin to border

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

Getter Method

Signature MarginToBorder

Returns:returns the margin to border.
Return type:float

New in version NX6.0.1.

License requirements: None.

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

Setter Method

Signature MarginToBorder

Parameters:marginToBorder (float) – sets the margin to border.

New in version NX6.0.1.

License requirements: nx_layout (“NX Layout”)

MultipleViewPlacement

StandardViewsBuilder.MultipleViewPlacement

Returns the multiple view placement

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

Getter Method

Signature MultipleViewPlacement

Returns:
Return type:NXOpen.Drawings.MultipleViewPlacementBuilder

New in version NX6.0.2.

License requirements: None.

NonSectionedObjects

StandardViewsBuilder.NonSectionedObjects

Returns the list of objects to not section in the view

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

Getter Method

Signature NonSectionedObjects

Returns:
Return type:NXOpen.Drawings.HiddenObjectsBuilder

New in version NX6.0.2.

License requirements: None.

Part

StandardViewsBuilder.Part

Returns or sets the part to use for base views

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

Getter Method

Signature Part

Returns:
Return type:NXOpen.Part

New in version NX6.0.2.

License requirements: None.

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

Setter Method

Signature Part

Parameters:part (NXOpen.Part) –

New in version NX6.0.2.

License requirements: nx_layout (“NX Layout”)

PlacementType

StandardViewsBuilder.PlacementType

Returns or sets the Placement type

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

Getter Method

Signature PlacementType

Returns:returns the placement type.
Return type:NXOpen.Drawings.StandardViewsBuilderPlacement

New in version NX6.0.1.

Deprecated since version NX6.0.2: Use the type of the multiple view placement

License requirements: None.

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

Setter Method

Signature PlacementType

Parameters:type (NXOpen.Drawings.StandardViewsBuilderPlacement) – sets the layout type.

New in version NX6.0.1.

Deprecated since version NX6.0.2: Use the type of the multiple view placement

License requirements: nx_layout (“NX Layout”)

Scale

StandardViewsBuilder.Scale

Returns the view scale

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

Getter Method

Signature Scale

Returns:
Return type:NXOpen.Drawings.ViewScaleBuilder

New in version NX6.0.1.

License requirements: None.

SecondCorner

StandardViewsBuilder.SecondCorner

Returns the second corner view placement

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

Getter Method

Signature SecondCorner

Returns:
Return type:NXOpen.Drawings.ViewPlacementBuilder

New in version NX6.0.1.

Deprecated since version NX6.0.2: Use the second corner of the multiple view placemnent builder instead

License requirements: None.

SecondaryComponents

StandardViewsBuilder.SecondaryComponents

Returns the list of secondary objects in the view

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

Getter Method

Signature SecondaryComponents

Returns:
Return type:NXOpen.Drawings.DraftingComponentSelectionBuilder

New in version NX11.0.0.

License requirements: None.

ViewPlacement

StandardViewsBuilder.ViewPlacement

Returns the view placement

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

Getter Method

Signature ViewPlacement

Returns:
Return type:NXOpen.Drawings.ViewPlacementBuilder

New in version NX6.0.1.

Deprecated since version NX6.0.2: Use GetMultipleViewPlacement instead

License requirements: None.

ViewStyle

StandardViewsBuilder.ViewStyle

Returns the view style

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

Getter Method

Signature ViewStyle

Returns:
Return type:NXOpen.Drawings.ViewStyleBuilder

New in version NX6.0.1.

License requirements: None.

ViewType

StandardViewsBuilder.ViewType

Returns or sets the view type

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

Getter Method

Signature ViewType

Returns:returns the view type.
Return type:NXOpen.Drawings.StandardViewsBuilderView

New in version NX6.0.2.

License requirements: None.

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

Setter Method

Signature ViewType

Parameters:viewType (NXOpen.Drawings.StandardViewsBuilderView) – sets the view type.

New in version NX6.0.2.

License requirements: nx_layout (“NX Layout”)

Method Detail

Validate

StandardViewsBuilder.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.