NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Drawings::StandardViewsBuilder Class Reference

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

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

Public Types

enum  Placement { PlacementCenter, PlacementCorner }
 The view Layout placement type (deprecated) More...
 
enum  Type {
  TypeFrontTop, TypeFrontRight, TypeFrontLeft, TypeFrontTopRight,
  TypeFrontTopLeft, TypeFrontTopRightIso, TypeFrontTopLeftIso
}
 The view Layout type. More...
 
enum  View { ViewDrawing, ViewBase }
 The view type to create. More...
 

Public Member Functions

bool Autoscale ()
 Returns the autoscale mode for base view creation
Created in NX6.0.2. More...
 
NXOpen::Drawings::ViewCenterCoordinateBuilderCoordinate ()
 Returns the center coordinate
Created in NX6.0.1. More...
 
NXOpen::Drawings::ViewPlacementBuilderFirstCorner ()
 Returns the first corner view placement
More...
 
NXOpen::Drawings::HiddenObjectsBuilderHiddenObjects ()
 Returns the list of objects to not show in the view
Created in NX6.0.2. More...
 
NXOpen::Drawings::StandardViewsBuilder::Type LayoutType ()
 Returns the Layout type
Created in NX6.0.1. More...
 
double MarginBetweenViews ()
 Returns the margin between views
Created in NX6.0.1. More...
 
double MarginToBorder ()
 Returns the margin to border
Created in NX6.0.1. More...
 
NXOpen::Drawings::MultipleViewPlacementBuilderMultipleViewPlacement ()
 Returns the multiple view placement
Created in NX6.0.2. More...
 
NXOpen::Drawings::HiddenObjectsBuilderNonSectionedObjects ()
 Returns the list of objects to not section in the view
Created in NX6.0.2. More...
 
NXOpen::PartPart ()
 Returns the part to use for base views
Created in NX6.0.2. More...
 
NXOpen::Drawings::StandardViewsBuilder::Placement PlacementType ()
 Returns the Placement type
More...
 
NXOpen::Drawings::ViewScaleBuilderScale ()
 Returns the view scale
Created in NX6.0.1. More...
 
NXOpen::Drawings::DraftingComponentSelectionBuilderSecondaryComponents ()
 Returns the list of secondary objects in the view
Created in NX11.0.0. More...
 
NXOpen::Drawings::ViewPlacementBuilderSecondCorner ()
 Returns the second corner view placement
More...
 
void SetAutoscale (bool autoScale)
 Sets the autoscale mode for base view creation
Created in NX6.0.2. More...
 
void SetLayoutType (NXOpen::Drawings::StandardViewsBuilder::Type type)
 Sets the Layout type
Created in NX6.0.1. More...
 
void SetMarginBetweenViews (double marginBetweenViews)
 Sets the margin between views
Created in NX6.0.1. More...
 
void SetMarginToBorder (double marginToBorder)
 Sets the margin to border
Created in NX6.0.1. More...
 
void SetPart (NXOpen::Part *part)
 Sets the part to use for base views
Created in NX6.0.2. More...
 
void SetPlacementType (NXOpen::Drawings::StandardViewsBuilder::Placement type)
 Sets the Placement type
More...
 
void SetViewType (NXOpen::Drawings::StandardViewsBuilder::View viewType)
 Sets the view type
Created in NX6.0.2. More...
 
NXOpen::Drawings::ViewPlacementBuilderViewPlacement ()
 Returns the view placement
More...
 
NXOpen::Drawings::ViewStyleBuilderViewStyle ()
 Returns the view style
Created in NX6.0.1. More...
 
NXOpen::Drawings::StandardViewsBuilder::View ViewType ()
 Returns the view type
Created in NX6.0.2. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX6.0.1.

Member Enumeration Documentation

The view Layout placement type (deprecated)

Enumerator
PlacementCenter 

center

PlacementCorner 

corner

The view Layout type.

Enumerator
TypeFrontTop 

front, top

TypeFrontRight 

front, right

TypeFrontLeft 

front, left

TypeFrontTopRight 

front, top, right

TypeFrontTopLeft 

front, top, left

TypeFrontTopRightIso 

front, top, right, iso

TypeFrontTopLeftIso 

front, top, left, iso

The view type to create.

Enumerator
ViewDrawing 

drawing (2d) views

ViewBase 

base views

Member Function Documentation

bool NXOpen::Drawings::StandardViewsBuilder::Autoscale ( )

Returns the autoscale mode for base view creation
Created in NX6.0.2.



License requirements : None

NXOpen::Drawings::ViewCenterCoordinateBuilder* NXOpen::Drawings::StandardViewsBuilder::Coordinate ( )

Returns the center coordinate
Created in NX6.0.1.



License requirements : None

NXOpen::Drawings::ViewPlacementBuilder* NXOpen::Drawings::StandardViewsBuilder::FirstCorner ( )

Returns the first corner view placement

Deprecated:
Deprecated in NX6.0.2.

Use the first corner of the multiple view placemnent builder instead


Created in NX6.0.1.

License requirements : None

NXOpen::Drawings::HiddenObjectsBuilder* NXOpen::Drawings::StandardViewsBuilder::HiddenObjects ( )

Returns the list of objects to not show in the view
Created in NX6.0.2.



License requirements : None

NXOpen::Drawings::StandardViewsBuilder::Type NXOpen::Drawings::StandardViewsBuilder::LayoutType ( )

Returns the Layout type
Created in NX6.0.1.



License requirements : None

double NXOpen::Drawings::StandardViewsBuilder::MarginBetweenViews ( )

Returns the margin between views
Created in NX6.0.1.



License requirements : None

double NXOpen::Drawings::StandardViewsBuilder::MarginToBorder ( )

Returns the margin to border
Created in NX6.0.1.



License requirements : None

NXOpen::Drawings::MultipleViewPlacementBuilder* NXOpen::Drawings::StandardViewsBuilder::MultipleViewPlacement ( )

Returns the multiple view placement
Created in NX6.0.2.



License requirements : None

NXOpen::Drawings::HiddenObjectsBuilder* NXOpen::Drawings::StandardViewsBuilder::NonSectionedObjects ( )

Returns the list of objects to not section in the view
Created in NX6.0.2.



License requirements : None

NXOpen::Part* NXOpen::Drawings::StandardViewsBuilder::Part ( )

Returns the part to use for base views
Created in NX6.0.2.



License requirements : None

NXOpen::Drawings::StandardViewsBuilder::Placement NXOpen::Drawings::StandardViewsBuilder::PlacementType ( )

Returns the Placement type

Deprecated:
Deprecated in NX6.0.2.

Use the type of the multiple view placement


Created in NX6.0.1.

License requirements : None

NXOpen::Drawings::ViewScaleBuilder* NXOpen::Drawings::StandardViewsBuilder::Scale ( )

Returns the view scale
Created in NX6.0.1.



License requirements : None

NXOpen::Drawings::DraftingComponentSelectionBuilder* NXOpen::Drawings::StandardViewsBuilder::SecondaryComponents ( )

Returns the list of secondary objects in the view
Created in NX11.0.0.



License requirements : None

NXOpen::Drawings::ViewPlacementBuilder* NXOpen::Drawings::StandardViewsBuilder::SecondCorner ( )

Returns the second corner view placement

Deprecated:
Deprecated in NX6.0.2.

Use the second corner of the multiple view placemnent builder instead


Created in NX6.0.1.

License requirements : None

void NXOpen::Drawings::StandardViewsBuilder::SetAutoscale ( bool  autoScale)

Sets the autoscale mode for base view creation
Created in NX6.0.2.



License requirements : nx_layout ("NX Layout")

Parameters
autoScalesets the auto-scale mode.
void NXOpen::Drawings::StandardViewsBuilder::SetLayoutType ( NXOpen::Drawings::StandardViewsBuilder::Type  type)

Sets the Layout type
Created in NX6.0.1.



License requirements : nx_layout ("NX Layout")

Parameters
typesets the layout type.
void NXOpen::Drawings::StandardViewsBuilder::SetMarginBetweenViews ( double  marginBetweenViews)

Sets the margin between views
Created in NX6.0.1.



License requirements : nx_layout ("NX Layout")

Parameters
marginBetweenViewssets the margin between views.
void NXOpen::Drawings::StandardViewsBuilder::SetMarginToBorder ( double  marginToBorder)

Sets the margin to border
Created in NX6.0.1.



License requirements : nx_layout ("NX Layout")

Parameters
marginToBordersets the margin to border.
void NXOpen::Drawings::StandardViewsBuilder::SetPart ( NXOpen::Part part)

Sets the part to use for base views
Created in NX6.0.2.



License requirements : nx_layout ("NX Layout")

Parameters
partpart
void NXOpen::Drawings::StandardViewsBuilder::SetPlacementType ( NXOpen::Drawings::StandardViewsBuilder::Placement  type)

Sets the Placement type

Deprecated:
Deprecated in NX6.0.2.

Use the type of the multiple view placement


Created in NX6.0.1.

License requirements : nx_layout ("NX Layout")

Parameters
typesets the layout type.
void NXOpen::Drawings::StandardViewsBuilder::SetViewType ( NXOpen::Drawings::StandardViewsBuilder::View  viewType)

Sets the view type
Created in NX6.0.2.



License requirements : nx_layout ("NX Layout")

Parameters
viewTypesets the view type.
NXOpen::Drawings::ViewPlacementBuilder* NXOpen::Drawings::StandardViewsBuilder::ViewPlacement ( )

Returns the view placement

Deprecated:
Deprecated in NX6.0.2.

Use GetMultipleViewPlacement instead


Created in NX6.0.1.

License requirements : None

NXOpen::Drawings::ViewStyleBuilder* NXOpen::Drawings::StandardViewsBuilder::ViewStyle ( )

Returns the view style
Created in NX6.0.1.



License requirements : None

NXOpen::Drawings::StandardViewsBuilder::View NXOpen::Drawings::StandardViewsBuilder::ViewType ( )

Returns the view type
Created in NX6.0.2.



License requirements : None


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