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

Represents a NXOpen.GeometricUtilities.ShapeFrameBuilder More...

Inheritance diagram for NXOpen.GeometricUtilities.ShapeFrameBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.GeometricUtilities.CircularFrameBuilder NXOpen.GeometricUtilities.QuadrilateralFrameBuilder NXOpen.GeometricUtilities.TriangularFrameBuilder

Public Types

enum  AnchorAttachmentType {
  None, Center, Vertex1, Vertex2,
  Vertex3, Vertex4
}
 Represents the anchor attachment type More...
 

Public Member Functions

unsafe NXOpen.Point2d GetMidpointCoords (int index)
 Gets the coordinates of the i-th midpoint of the frame with respect to the plane More...
 
unsafe NXOpen.Point2d GetVertexCoords (int index)
 Gets the coordinates of the i-th vertex of the frame with respect to the plane More...
 
unsafe void SetMidpointCoords (int index, NXOpen.Point2d coords)
 Sets the coordinates of the i-th midpoint of the frame with respect to the plane More...
 
unsafe void SetVertexCoords (int index, NXOpen.Point2d coords)
 Sets the coordinates of the i-th vertex of the frame with respect to the plane More...
 
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.GeometricUtilities.AnchorLocatorBuilder 
Anchor [get]
 Returns the anchor of the frame More...
 
unsafe
NXOpen.GeometricUtilities.ShapeFrameBuilder.AnchorAttachmentType 
AnchorAttachment [get, set]
 Returns or sets the anchor attachment More...
 
unsafe int NumberVertices [get]
 Returns the number of vertices of the frame 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.GeometricUtilities.ShapeFrameBuilder

Created in NX6.0.0

Member Enumeration Documentation

Represents the anchor attachment type

Enumerator
None 

Anchor is not attached to the frame

Center 

Anchor is attached to the center of the frame

Vertex1 

Anchor is attached to the first vertex of the frame

Vertex2 

Anchor is attached to the second vertex of the frame

Vertex3 

Anchor is attached to the third vertex of the frame

Vertex4 

Anchor is attached to the fourth vertex of the frame

Member Function Documentation

unsafe NXOpen.Point2d NXOpen.GeometricUtilities.ShapeFrameBuilder.GetMidpointCoords ( int  index)
inline

Gets the coordinates of the i-th midpoint of the frame with respect to the plane

Created in NX6.0.0

License requirements: None.

Parameters
indexindex of midpoint
Returns
coordinates of midpoint relative with respect to plane
unsafe NXOpen.Point2d NXOpen.GeometricUtilities.ShapeFrameBuilder.GetVertexCoords ( int  index)
inline

Gets the coordinates of the i-th vertex of the frame with respect to the plane

Created in NX6.0.0

License requirements: None.

Parameters
indexindex of vertex
Returns
coordinates of vertex relative with respect to plane
unsafe void NXOpen.GeometricUtilities.ShapeFrameBuilder.SetMidpointCoords ( int  index,
NXOpen.Point2d  coords 
)
inline

Sets the coordinates of the i-th midpoint of the frame with respect to the plane

Created in NX6.0.0

License requirements: None.

Parameters
indexindex of midpoint
coordscoordinates of midpoint relative with respect to plane
unsafe void NXOpen.GeometricUtilities.ShapeFrameBuilder.SetVertexCoords ( int  index,
NXOpen.Point2d  coords 
)
inline

Sets the coordinates of the i-th vertex of the frame with respect to the plane

Created in NX6.0.0

License requirements: None.

Parameters
indexindex of vertex
coordscoordinates of vertex relative with respect to plane
unsafe bool NXOpen.GeometricUtilities.ShapeFrameBuilder.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.GeometricUtilities.AnchorLocatorBuilder NXOpen.GeometricUtilities.ShapeFrameBuilder.Anchor
get

Returns the anchor of the frame

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.ShapeFrameBuilder.AnchorAttachmentType NXOpen.GeometricUtilities.ShapeFrameBuilder.AnchorAttachment
getset

Returns or sets the anchor attachment

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.GeometricUtilities.ShapeFrameBuilder.NumberVertices
get

Returns the number of vertices of the frame

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.