public interface ViewPlacementBuilder extends TaggedObject, IComponentBuilder
ViewPlacementBuilder
. This class
is used to define the origin of a view.
Modifier and Type | Interface and Description |
---|---|
static class |
ViewPlacementBuilder.Method
view method
|
static class |
ViewPlacementBuilder.Option
view option
|
Modifier and Type | Method and Description |
---|---|
ViewPlacementBuilder.Method |
alignmentMethod()
Returns the alignment method
License requirements: None. |
ViewPlacementBuilder.Option |
alignmentOption()
Returns the alignment option used to indicate what points in the views to align.
|
SelectTaggedObject |
alignmentPoint()
Returns the point to align to.
|
nxopen.Direction |
alignmentVector()
Returns the vector to align along.
|
SelectDraftingView |
alignmentView()
Returns the view to align to.
|
boolean |
associative()
Returns the flag used to create a persistent alignment
License requirements: drafting ("DRAFTING") . |
SelectTaggedObject |
candidatePoint()
Returns the point to align in the view being edited.
|
boolean |
lockOffset()
Returns the lock offset flag.
|
double |
offset()
Returns the offset.
|
SelectNXObject |
placement()
Returns the placement location.
|
void |
setAlignmentMethod(ViewPlacementBuilder.Method alignmentMethod)
License requirements: drafting ("DRAFTING") . |
void |
setAlignmentOption(ViewPlacementBuilder.Option alignmentOption)
License requirements: drafting ("DRAFTING") . |
void |
setAlignmentVector(nxopen.Direction alignmentVector)
License requirements: drafting ("DRAFTING") . |
void |
setAssociative(boolean associative)
License requirements: drafting ("DRAFTING") . |
void |
setLockOffset(boolean lockOffset)
License requirements: drafting ("DRAFTING") . |
void |
setOffset(double offset)
License requirements: drafting ("DRAFTING") . |
printTestData, printTestData, tag, tagValue
validate
SelectNXObject placement() throws NXException, RemoteException
Point
class or not
selecting an object and specifying a Point3d
selected object point. If the alignment method is set to
ViewPlacementBuilder.Method.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.
NXException
RemoteException
ViewPlacementBuilder.Method alignmentMethod() throws NXException, RemoteException
NXException
RemoteException
void setAlignmentMethod(ViewPlacementBuilder.Method alignmentMethod) throws NXException, RemoteException
alignmentMethod
- NXException
RemoteException
nxopen.Direction alignmentVector() throws NXException, RemoteException
ViewPlacementBuilder.Method.PERPENDICULAR_TO_LINE
alignment
method. The vector must be set regardless of the alignment option.
NXException
RemoteException
void setAlignmentVector(nxopen.Direction alignmentVector) throws NXException, RemoteException
alignmentVector
- NXException
RemoteException
ViewPlacementBuilder.Option alignmentOption() throws NXException, RemoteException
ViewPlacementBuilder.Method.INFER
.
NXException
RemoteException
void setAlignmentOption(ViewPlacementBuilder.Option alignmentOption) throws NXException, RemoteException
alignmentOption
- NXException
RemoteException
SelectDraftingView alignmentView() throws NXException, RemoteException
ViewPlacementBuilder.Method.INFER
.
NXException
RemoteException
SelectTaggedObject alignmentPoint() throws NXException, RemoteException
ViewPlacementBuilder.Option.MODEL_POINT
and
ViewPlacementBuilder.Option.POINT_TO_POINT
alignment options.
The point is required for all alignment methods except for
ViewPlacementBuilder.Method.INFER
.
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.
NXException
RemoteException
SelectTaggedObject candidatePoint() throws NXException, RemoteException
ViewPlacementBuilder.Option.POINT_TO_POINT
alignment option. The point is required for all alignment methods
except ViewPlacementBuilder.Method.INFER
.
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.
NXException
RemoteException
boolean lockOffset() throws NXException, RemoteException
NXException
RemoteException
void setLockOffset(boolean lockOffset) throws NXException, RemoteException
lockOffset
- NXException
RemoteException
double offset() throws NXException, RemoteException
ViewPlacementBuilder.Method.OVERLAY
. If the
ViewPlacementBuilder.Method.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.
NXException
RemoteException
void setOffset(double offset) throws NXException, RemoteException
offset
- NXException
RemoteException
boolean associative() throws NXException, RemoteException
NXException
RemoteException
void setAssociative(boolean associative) throws NXException, RemoteException
associative
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.