ViewPlacementBuilder Class¶
-
class
NXOpen.Drawings.
ViewPlacementBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Drawings.ViewPlacementBuilder
.This class is used to define the origin of a view.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AlignmentMethod | Returns or sets the alignment method |
AlignmentOption | Returns or sets the alignment option used to indicate what points in the views to align. |
AlignmentPoint | Returns the point to align to. |
AlignmentVector | Returns or sets the vector to align along. |
AlignmentView | Returns the view to align to. |
Associative | Returns or sets the flag used to create a persistent alignment |
CandidatePoint | Returns the point to align in the view being edited. |
LockOffset | Returns or sets the lock offset flag. |
Offset | Returns or sets the offset. |
Placement | Returns the placement location. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ViewPlacementBuilderMethod Enumeration | view method |
ViewPlacementBuilderOption Enumeration | view option |
Property Detail¶
AlignmentMethod¶
-
ViewPlacementBuilder.
AlignmentMethod
¶ Returns or sets the alignment method
-------------------------------------
Getter Method
Signature
AlignmentMethod()
Returns: Return type: NXOpen.Drawings.ViewPlacementBuilderMethod
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlignmentMethod(alignmentMethod)
Parameters: alignmentMethod ( NXOpen.Drawings.ViewPlacementBuilderMethod
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
AlignmentOption¶
-
ViewPlacementBuilder.
AlignmentOption
¶ Returns or 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
NXOpen.Drawings.ViewPlacementBuilderMethod.Infer
.-------------------------------------
Getter Method
Signature
AlignmentOption()
Returns: Return type: NXOpen.Drawings.ViewPlacementBuilderOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlignmentOption(alignmentOption)
Parameters: alignmentOption ( NXOpen.Drawings.ViewPlacementBuilderOption
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
AlignmentPoint¶
-
ViewPlacementBuilder.
AlignmentPoint
¶ Returns the point to align to.
This point is only required for the
NXOpen.Drawings.ViewPlacementBuilderOption.ModelPoint
andNXOpen.Drawings.ViewPlacementBuilderOption.PointToPoint
alignment options. The point is required for all alignment methods except forNXOpen.Drawings.ViewPlacementBuilderMethod.Infer
. This point may be specified by either selecting an object ofNXOpen.Point
class or not selecting an object and specifying aNXOpen.Point3d
selected object point.-------------------------------------
Getter Method
Signature
AlignmentPoint()
Returns: Return type: NXOpen.SelectTaggedObject
New in version NX6.0.0.
License requirements: None.
AlignmentVector¶
-
ViewPlacementBuilder.
AlignmentVector
¶ Returns or sets the vector to align along.
The vector is only required for the
NXOpen.Drawings.ViewPlacementBuilderMethod.PerpendicularToLine
alignment method. The vector must be set regardless of the alignment option.-------------------------------------
Getter Method
Signature
AlignmentVector()
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlignmentVector(alignmentVector)
Parameters: alignmentVector ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
AlignmentView¶
-
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
NXOpen.Drawings.ViewPlacementBuilderMethod.Infer
.-------------------------------------
Getter Method
Signature
AlignmentView()
Returns: Return type: NXOpen.Drawings.SelectDraftingView
New in version NX6.0.0.
License requirements: None.
Associative¶
-
ViewPlacementBuilder.
Associative
¶ Returns or sets the flag used to create a persistent alignment
-------------------------------------
Getter Method
Signature
Associative()
Returns: Return type: bool New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
-------------------------------------
Setter Method
Signature
Associative(associative)
Parameters: associative (bool) – New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
CandidatePoint¶
-
ViewPlacementBuilder.
CandidatePoint
¶ Returns the point to align in the view being edited.
This point is only required for the
NXOpen.Drawings.ViewPlacementBuilderOption.PointToPoint
alignment option. The point is required for all alignment methods exceptNXOpen.Drawings.ViewPlacementBuilderMethod.Infer
. This point may be specified by either selecting an object ofNXOpen.Point
class or not selecting an object and specifying aNXOpen.Point3d
selected object point.-------------------------------------
Getter Method
Signature
CandidatePoint()
Returns: Return type: NXOpen.SelectTaggedObject
New in version NX6.0.0.
License requirements: None.
LockOffset¶
-
ViewPlacementBuilder.
LockOffset
¶ Returns or sets the lock offset flag.
Use the offset property if this flag is set to true.
-------------------------------------
Getter Method
Signature
LockOffset()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LockOffset(lockOffset)
Parameters: lockOffset (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Offset¶
-
ViewPlacementBuilder.
Offset
¶ Returns or 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
NXOpen.Drawings.ViewPlacementBuilderMethod.Overlay
. If theNXOpen.Drawings.ViewPlacementBuilderMethod.Infer
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.-------------------------------------
Getter Method
Signature
Offset()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Offset(offset)
Parameters: offset (float) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Placement¶
-
ViewPlacementBuilder.
Placement
¶ Returns the placement location.
The location may be specified by either selecting an object of
NXOpen.Point
class or not selecting an object and specifying aNXOpen.Point3d
selected object point. If the alignment method is set toNXOpen.Drawings.ViewPlacementBuilderMethod.Infer
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.-------------------------------------
Getter Method
Signature
Placement()
Returns: Return type: NXOpen.SelectNXObject
New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ViewPlacementBuilder.
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.