Represents a Drawings::ViewPlacementBuilder . More...

Inheritance diagram for NXOpen::Drawings::ViewPlacementBuilder:

Public Types
enum	Method { MethodInfer, MethodHorizontal, MethodVertical, MethodPerpendicularToLine, MethodOverlay, MethodPerpendicularToHingeLine, MethodMax }
	view method More...

enum	Option { OptionToView, OptionModelPoint, OptionPointToPoint }
	view option More...

Public Member Functions
NXOpen::Drawings::ViewPlacementBuilder::Method	AlignmentMethod ()
	Returns the alignment method Created in NX6.0.0.

NXOpen::Drawings::ViewPlacementBuilder::Option	AlignmentOption ()
	Returns the alignment option used to indicate what points in the views to align.

NXOpen::SelectTaggedObject *	AlignmentPoint ()
	Returns the point to align to.

NXOpen::Direction *	AlignmentVector ()
	Returns the vector to align along.

NXOpen::Drawings::SelectDraftingView *	AlignmentView ()
	Returns the view to align to.

bool	Associative ()
	Returns the flag used to create a persistent alignment Created in NX8.5.0.

NXOpen::SelectTaggedObject *	CandidatePoint ()
	Returns the point to align in the view being edited.

bool	LockOffset ()
	Returns the lock offset flag.

double	Offset ()
	Returns the offset.

NXOpen::SelectNXObject *	Placement ()
	Returns the placement location.

void	SetAlignmentMethod (NXOpen::Drawings::ViewPlacementBuilder::Method alignmentMethod)
	Sets the alignment method Created in NX6.0.0.

void	SetAlignmentOption (NXOpen::Drawings::ViewPlacementBuilder::Option alignmentOption)
	Sets the alignment option used to indicate what points in the views to align.

void	SetAlignmentVector (NXOpen::Direction *alignmentVector)
	Sets the vector to align along.

void	SetAssociative (bool associative)
	Sets the flag used to create a persistent alignment Created in NX8.5.0.

void	SetLockOffset (bool lockOffset)
	Sets the lock offset flag.

void	SetOffset (double offset)
	Sets the offset.

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

This class is used to define the origin of a view.

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::ViewPlacementBuilder::Method

view method

Enumerator:

MethodInfer	Infer the view position.
MethodHorizontal	Align the view horizontally to another view.
MethodVertical	Align the view vertically to another view.
MethodPerpendicularToLine	Align the view along some line to another view.
MethodOverlay	Align the view on top of another view.
MethodPerpendicularToHingeLine	Align the view along the hinge line.
MethodMax	Should be the last enum in the list.

enum NXOpen::Drawings::ViewPlacementBuilder::Option

view option

Enumerator:

OptionToView	Align to the view centers.
OptionModelPoint	Align to the same point in the alignment view and the view being edited.
OptionPointToPoint	Align a point in the alignment view to another point in the view being edited.

Member Function Documentation

NXOpen::Drawings::ViewPlacementBuilder::Method NXOpen::Drawings::ViewPlacementBuilder::AlignmentMethod ( )

Returns the alignment method
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::ViewPlacementBuilder::Option NXOpen::Drawings::ViewPlacementBuilder::AlignmentOption ( )

Returns the alignment option used to indicate what points in the views to align.

       The alignment option is not used when the alignment method is set
       to @link Drawings::ViewPlacementBuilder::MethodInfer Drawings::ViewPlacementBuilder::MethodInfer@endlink .

Created in NX6.0.0.

License requirements : None

NXOpen::SelectTaggedObject* NXOpen::Drawings::ViewPlacementBuilder::AlignmentPoint ( )

Returns the point to align to.

This point is only required for the Drawings::ViewPlacementBuilder::OptionModelPoint and Drawings::ViewPlacementBuilder::OptionPointToPoint alignment options. The point is required for all alignment methods except for Drawings::ViewPlacementBuilder::MethodInfer . This point may be specified by either selecting an object of Point class or not selecting an object and specifying a Point3d selected object point.
Created in NX6.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Drawings::ViewPlacementBuilder::AlignmentVector ( )

Returns the vector to align along.

The vector is only required for the Drawings::ViewPlacementBuilder::MethodPerpendicularToLine alignment method. The vector must be set regardless of the alignment option.
Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SelectDraftingView* NXOpen::Drawings::ViewPlacementBuilder::AlignmentView ( )

Returns the view to align to.

The view is required for all alignment options. The view is required for all alignment methods except for Drawings::ViewPlacementBuilder::MethodInfer .
Created in NX6.0.0.

License requirements : None

bool NXOpen::Drawings::ViewPlacementBuilder::Associative ( )

Returns the flag used to create a persistent alignment
Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

NXOpen::SelectTaggedObject* NXOpen::Drawings::ViewPlacementBuilder::CandidatePoint ( )

Returns the point to align in the view being edited.

This point is only required for the Drawings::ViewPlacementBuilder::OptionPointToPoint alignment option. The point is required for all alignment methods except Drawings::ViewPlacementBuilder::MethodInfer . This point may be specified by either selecting an object of Point class or not selecting an object and specifying a Point3d selected object point.
Created in NX6.0.0.

License requirements : None

bool NXOpen::Drawings::ViewPlacementBuilder::LockOffset ( )

Returns the lock offset flag.

Use the offset property if this flag is set to true.
Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::ViewPlacementBuilder::Offset ( )

Returns the offset.

If the lock offset flag is set to true then the offset will be applied. The offset has no meaning when used with the Drawings::ViewPlacementBuilder::MethodOverlay . If the Drawings::ViewPlacementBuilder::MethodInfer method is set, then the offset is defined as the distance from the view to its parent view. For all other methods, the offset is defined as the distance along the line being aligned to.
Created in NX6.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Drawings::ViewPlacementBuilder::Placement ( )

Returns the placement location.

The location may be specified by either selecting an object of Point class or not selecting an object and specifying a Point3d selected object point. If the alignment method is set to Drawings::ViewPlacementBuilder::MethodInfer then the location defines the position of the view's center. The location is not necessarily the position of the view. The location provides a hint point that helps determine the view's position based on the alignment method and alignment point specified.
Created in NX6.0.0.

License requirements : None

void NXOpen::Drawings::ViewPlacementBuilder::SetAlignmentMethod ( NXOpen::Drawings::ViewPlacementBuilder::Method alignmentMethod )

Sets the alignment method
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

alignmentMethod alignmentmethod

void NXOpen::Drawings::ViewPlacementBuilder::SetAlignmentOption ( NXOpen::Drawings::ViewPlacementBuilder::Option alignmentOption )

Sets the alignment option used to indicate what points in the views to align.

       The alignment option is not used when the alignment method is set
       to @link Drawings::ViewPlacementBuilder::MethodInfer Drawings::ViewPlacementBuilder::MethodInfer@endlink .

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

alignmentOption alignmentoption

void NXOpen::Drawings::ViewPlacementBuilder::SetAlignmentVector ( NXOpen::Direction * alignmentVector )

Sets the vector to align along.

The vector is only required for the Drawings::ViewPlacementBuilder::MethodPerpendicularToLine alignment method. The vector must be set regardless of the alignment option.
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

alignmentVector alignmentvector

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

Sets the flag used to create a persistent alignment
Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters

associative associative

void NXOpen::Drawings::ViewPlacementBuilder::SetLockOffset ( bool lockOffset )

Sets the lock offset flag.

Use the offset property if this flag is set to true.
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

lockOffset lockoffset

void NXOpen::Drawings::ViewPlacementBuilder::SetOffset ( double offset )

Sets the offset.

If the lock offset flag is set to true then the offset will be applied. The offset has no meaning when used with the Drawings::ViewPlacementBuilder::MethodOverlay . If the Drawings::ViewPlacementBuilder::MethodInfer method is set, then the offset is defined as the distance from the view to its parent view. For all other methods, the offset is defined as the distance along the line being aligned to.
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

offset offset

virtual bool NXOpen::Drawings::ViewPlacementBuilder::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_ViewPlacementBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation