Represents a Drawings::DetailView . More...

Inheritance diagram for NXOpen::Drawings::DetailViewBuilder:

Public Types
enum	LabelOnParentType { LabelOnParentTypeNone, LabelOnParentTypeCircle, LabelOnParentTypeNote, LabelOnParentTypeLabel, LabelOnParentTypeEmbedded, LabelOnParentTypeBoundary }
	the display type for the label on parent More...

enum	Types { TypesUndefined = -1, TypesCircular, TypesRectangleByCorners, TypesRectangleByCenterAndCorner, TypesCustom }
	the type of boundary More...

Public Member Functions
bool	Associative ()
	Returns the associative toggle If view is associative and set associative to false, the view will be converted to independent detail view.

NXOpen::Point *	BoundaryPoint1 ()
	Returns the first boundary point.

NXOpen::Point *	BoundaryPoint2 ()
	Returns the second boundary point.

NXOpen::Drawings::HiddenObjectsBuilder *	HiddenObjects ()
	Returns the list of objects to not show in the view Created in NX6.0.0.

NXOpen::Drawings::DetailViewBuilder::LabelOnParentType	LabelOnParent ()
	Returns the label on parent Created in NX6.0.0.

NXOpen::Drawings::HiddenObjectsBuilder *	NonSectionedObjects ()
	Returns the list of objects to not section in the view Created in NX6.0.0.

NXOpen::Drawings::ViewPlacementBuilder *	Origin ()
	Returns the origin Created in NX6.0.0.

NXOpen::Drawings::ParentViewBuilder *	Parent ()
	Returns the parent view Created in NX6.0.0.

NXOpen::Drawings::ViewScaleBuilder *	Scale ()
	Returns the scale Created in NX6.0.0.

void	SetAssociative (bool associative)
	Sets the associative toggle If view is associative and set associative to false, the view will be converted to independent detail view.

void	SetBoundaryPoint1 (NXOpen::Point *boundaryPoint1)
	Sets the first boundary point.

void	SetBoundaryPoint2 (NXOpen::Point *boundaryPoint2)
	Sets the second boundary point.

void	SetLabelOnParent (NXOpen::Drawings::DetailViewBuilder::LabelOnParentType labelOnParent)
	Sets the label on parent Created in NX6.0.0.

void	SetType (NXOpen::Drawings::DetailViewBuilder::Types type)
	Sets the type Created in NX6.0.0.

NXOpen::Drawings::ViewStyleBuilder *	Style ()
	Returns the style Created in NX6.0.0.

NXOpen::Drawings::DetailViewBuilder::Types	Type ()
	Returns the type Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

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::DetailView .

This class is used to create and edit Detail Views
To create a new instance of this class, use Drawings::DraftingViewCollection::CreateDetailViewBuilder
Default values.

Property

Value

Origin.AlignmentMethod

Infer

Origin.AlignmentOption

ToView

Scale.Denominator

1.0

Scale.Numerator

1.0

Scale.ScaleType

Ratio

Style.ViewStyleGeneral.AngleValue

0.0

Style.ViewStyleOrientation.HingeLine.ReverseDirection

false

Style.ViewStyleOrientation.HingeLine.VectorOption

Inferred

Style.ViewStyleOrientation.Ovt.AssociativeOrientation

0

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::DetailViewBuilder::LabelOnParentType

the display type for the label on parent

Enumerator:

LabelOnParentTypeNone	No display.
LabelOnParentTypeCircle	Circular.
LabelOnParentTypeNote	Circular with a note.
LabelOnParentTypeLabel	Circular with a label.
LabelOnParentTypeEmbedded	Circular with a note embedded.
LabelOnParentTypeBoundary	The shape is the same as the boundary.

enum NXOpen::Drawings::DetailViewBuilder::Types

the type of boundary

Enumerator:

TypesCircular	Circular boundary.
TypesRectangleByCorners	Rectangular boundary defined by two corners.
TypesRectangleByCenterAndCorner	Rectangular boundary defined by the center and a corner.
TypesCustom	Custom boundary (this should not be used unless the detail view already has a custom boundary.

Member Function Documentation

bool NXOpen::Drawings::DetailViewBuilder::Associative ( )

Returns the associative toggle If view is associative and set associative to false, the view will be converted to independent detail view.

Otherwise, this setting will have no effect

Created in NX7.5.0.

License requirements : None

NXOpen::Point* NXOpen::Drawings::DetailViewBuilder::BoundaryPoint1 ( )

Returns the first boundary point.

This is the center of the boundary for these types: Drawings::DetailViewBuilder::TypesCircular and Drawings::DetailViewBuilder::TypesRectangleByCenterAndCorner

Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::Drawings::DetailViewBuilder::BoundaryPoint2 ( )

Returns the second boundary point.

This is the point on the circle for the Drawings::DetailViewBuilder::TypesCircular and the corner point for the Drawings::DetailViewBuilder::TypesRectangleByCenterAndCorner .

Created in NX6.0.0.

License requirements : None

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

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

License requirements : None

NXOpen::Drawings::DetailViewBuilder::LabelOnParentType NXOpen::Drawings::DetailViewBuilder::LabelOnParent ( )

Returns the label on parent
Created in NX6.0.0.

License requirements : None

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

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

License requirements : None

NXOpen::Drawings::ViewPlacementBuilder* NXOpen::Drawings::DetailViewBuilder::Origin ( )

Returns the origin
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::ParentViewBuilder* NXOpen::Drawings::DetailViewBuilder::Parent ( )

Returns the parent view
Created in NX6.0.0.

License requirements : None

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

Returns the scale
Created in NX6.0.0.

License requirements : None

void NXOpen::Drawings::DetailViewBuilder::SetAssociative ( bool associative )

Sets the associative toggle If view is associative and set associative to false, the view will be converted to independent detail view.

Otherwise, this setting will have no effect

Created in NX7.5.0.

License requirements : None

Parameters

associative associative

void NXOpen::Drawings::DetailViewBuilder::SetBoundaryPoint1 ( NXOpen::Point * boundaryPoint1 )

Sets the first boundary point.

This is the center of the boundary for these types: Drawings::DetailViewBuilder::TypesCircular and Drawings::DetailViewBuilder::TypesRectangleByCenterAndCorner

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

boundaryPoint1 boundarypoint1

void NXOpen::Drawings::DetailViewBuilder::SetBoundaryPoint2 ( NXOpen::Point * boundaryPoint2 )

Sets the second boundary point.

This is the point on the circle for the Drawings::DetailViewBuilder::TypesCircular and the corner point for the Drawings::DetailViewBuilder::TypesRectangleByCenterAndCorner .

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

boundaryPoint2 boundarypoint2

void NXOpen::Drawings::DetailViewBuilder::SetLabelOnParent ( NXOpen::Drawings::DetailViewBuilder::LabelOnParentType labelOnParent )

Sets the label on parent
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelOnParent labelonparent

void NXOpen::Drawings::DetailViewBuilder::SetType ( NXOpen::Drawings::DetailViewBuilder::Types type )

Sets the type
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

type type

NXOpen::Drawings::ViewStyleBuilder* NXOpen::Drawings::DetailViewBuilder::Style ( )

Returns the style
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::DetailViewBuilder::Types NXOpen::Drawings::DetailViewBuilder::Type ( )

Returns the type
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Drawings_DetailViewBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation