NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Drawings.ViewPlacementBuilder Class Reference

Represents a NXOpen.Drawings.ViewPlacementBuilder . More...

Inheritance diagram for NXOpen.Drawings.ViewPlacementBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Method {
  Infer, Horizontal, Vertical, PerpendicularToLine,
  Overlay, PerpendicularToHingeLine, Max
}
 view method More...
 
enum  Option { ToView, ModelPoint, PointToPoint }
 view option More...
 

Public Member Functions

unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Drawings.ViewPlacementBuilder.Method 
AlignmentMethod [get, set]
 Returns or sets the alignment method More...
 
unsafe
NXOpen.Drawings.ViewPlacementBuilder.Option 
AlignmentOption [get, set]
 Returns or sets the alignment option used to indicate what points in the views to align. More...
 
unsafe NXOpen.SelectTaggedObject AlignmentPoint [get]
 Returns the point to align to. More...
 
unsafe NXOpen.Direction AlignmentVector [get, set]
 Returns or sets the vector to align along. More...
 
unsafe
NXOpen.Drawings.SelectDraftingView 
AlignmentView [get]
 Returns the view to align to. More...
 
unsafe bool Associative [get, set]
 Returns or sets the flag used to create a persistent alignment More...
 
unsafe NXOpen.SelectTaggedObject CandidatePoint [get]
 Returns the point to align in the view being edited. More...
 
unsafe bool LockOffset [get, set]
 Returns or sets the lock offset flag. More...
 
unsafe double Offset [get, set]
 Returns or sets the offset. More...
 
unsafe NXOpen.SelectNXObject Placement [get]
 Returns the placement location. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Drawings.ViewPlacementBuilder .

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

Created in NX6.0.0

Member Enumeration Documentation

view method

Enumerator
Infer 

Infer the view position

Horizontal 

Align the view horizontally to another view

Vertical 

Align the view vertically to another view

PerpendicularToLine 

Align the view along some line to another view

Overlay 

Align the view on top of another view

PerpendicularToHingeLine 

Align the view along the hinge line

Max 

Should be the last enum in the list

view option

Enumerator
ToView 

Align to the view centers

ModelPoint 

Align to the same point in the alignment view and the view being edited

PointToPoint 

Align a point in the alignment view to another point in the view being edited

Member Function Documentation

unsafe bool NXOpen.Drawings.ViewPlacementBuilder.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Drawings.ViewPlacementBuilder.Method NXOpen.Drawings.ViewPlacementBuilder.AlignmentMethod
getset

Returns or sets the alignment method

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")

unsafe NXOpen.Drawings.ViewPlacementBuilder.Option NXOpen.Drawings.ViewPlacementBuilder.AlignmentOption
getset

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.ViewPlacementBuilder.Method.Infer .

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")

unsafe NXOpen.SelectTaggedObject NXOpen.Drawings.ViewPlacementBuilder.AlignmentPoint
get

Returns the point to align to.

This point is only required for the NXOpen.Drawings.ViewPlacementBuilder.Option.ModelPoint and NXOpen.Drawings.ViewPlacementBuilder.Option.PointToPoint alignment options. The point is required for all alignment methods except for NXOpen.Drawings.ViewPlacementBuilder.Method.Infer . This point may be specified by either selecting an object of NXOpen.Point class or not selecting an object and specifying a NXOpen.Point3d selected object point.

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Direction NXOpen.Drawings.ViewPlacementBuilder.AlignmentVector
getset

Returns or sets the vector to align along.

The vector is only required for the NXOpen.Drawings.ViewPlacementBuilder.Method.PerpendicularToLine alignment method. The vector must be set regardless of the alignment option.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")

unsafe NXOpen.Drawings.SelectDraftingView NXOpen.Drawings.ViewPlacementBuilder.AlignmentView
get

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.ViewPlacementBuilder.Method.Infer .

Created in NX6.0.0

License requirements: None.

unsafe bool NXOpen.Drawings.ViewPlacementBuilder.Associative
getset

Returns or sets the flag used to create a persistent alignment

Created in NX8.5.0

License requirements to get this property: drafting ("DRAFTING")

License requirements to set this property: drafting ("DRAFTING")

unsafe NXOpen.SelectTaggedObject NXOpen.Drawings.ViewPlacementBuilder.CandidatePoint
get

Returns the point to align in the view being edited.

This point is only required for the NXOpen.Drawings.ViewPlacementBuilder.Option.PointToPoint alignment option. The point is required for all alignment methods except NXOpen.Drawings.ViewPlacementBuilder.Method.Infer . This point may be specified by either selecting an object of NXOpen.Point class or not selecting an object and specifying a NXOpen.Point3d selected object point.

Created in NX6.0.0

License requirements: None.

unsafe bool NXOpen.Drawings.ViewPlacementBuilder.LockOffset
getset

Returns or sets the lock offset flag.

Use the offset property if this flag is set to true.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")

unsafe double NXOpen.Drawings.ViewPlacementBuilder.Offset
getset

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.ViewPlacementBuilder.Method.Overlay . If the NXOpen.Drawings.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.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")

unsafe NXOpen.SelectNXObject NXOpen.Drawings.ViewPlacementBuilder.Placement
get

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 a NXOpen.Point3d selected object point. If the alignment method is set to NXOpen.Drawings.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.

Created in NX6.0.0

License requirements: None.


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