NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::ShapeFrameBuilder Class Reference

Represents a GeometricUtilities::ShapeFrameBuilder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::GeometricUtilities::ShapeFrameBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::GeometricUtilities::CircularFrameBuilder NXOpen::GeometricUtilities::QuadrilateralFrameBuilder NXOpen::GeometricUtilities::TriangularFrameBuilder

List of all members.

Public Types

enum  AnchorAttachmentType {
  AnchorAttachmentTypeNone, AnchorAttachmentTypeCenter, AnchorAttachmentTypeVertex1, AnchorAttachmentTypeVertex2,
  AnchorAttachmentTypeVertex3, AnchorAttachmentTypeVertex4
}
 Represents the anchor attachment type. More...

Public Member Functions

NXOpen::GeometricUtilities::AnchorLocatorBuilderAnchor ()
 Returns the anchor of the frame
Created in NX6.0.0.
NXOpen::GeometricUtilities::ShapeFrameBuilder::AnchorAttachmentType AnchorAttachment ()
 Returns the anchor attachment
Created in NX6.0.0.
NXOpen::Point2d GetMidpointCoords (int index)
 Gets the coordinates of the i-th midpoint of the frame with respect to the plane.
NXOpen::Point2d GetVertexCoords (int index)
 Gets the coordinates of the i-th vertex of the frame with respect to the plane.
int NumberVertices ()
 Returns the number of vertices of the frame
Created in NX6.0.0.
void SetAnchorAttachment (NXOpen::GeometricUtilities::ShapeFrameBuilder::AnchorAttachmentType anchorAttachment)
 Sets the anchor attachment
Created in NX6.0.0.
void SetMidpointCoords (int index, const NXOpen::Point2d &coords)
 Sets the coordinates of the i-th midpoint of the frame with respect to the plane
Created in NX6.0.0.
void SetVertexCoords (int index, const NXOpen::Point2d &coords)
 Sets the coordinates of the i-th vertex of the frame with respect to the plane
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a GeometricUtilities::ShapeFrameBuilder
Created in NX6.0.0.



Member Enumeration Documentation

Represents the anchor attachment type.

Enumerator:
AnchorAttachmentTypeNone 

Anchor is not attached to the frame.

AnchorAttachmentTypeCenter 

Anchor is attached to the center of the frame.

AnchorAttachmentTypeVertex1 

Anchor is attached to the first vertex of the frame.

AnchorAttachmentTypeVertex2 

Anchor is attached to the second vertex of the frame.

AnchorAttachmentTypeVertex3 

Anchor is attached to the third vertex of the frame.

AnchorAttachmentTypeVertex4 

Anchor is attached to the fourth vertex of the frame.


Member Function Documentation

Returns the anchor of the frame
Created in NX6.0.0.



License requirements : None

Returns the anchor attachment
Created in NX6.0.0.



License requirements : None

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

Returns:
coordinates of midpoint relative with respect to plane
Created in NX6.0.0.

License requirements : None
Parameters:
indexindex of midpoint

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

Returns:
coordinates of vertex relative with respect to plane
Created in NX6.0.0.

License requirements : None
Parameters:
indexindex of vertex

Returns the number of vertices of the frame
Created in NX6.0.0.



License requirements : None

Sets the anchor attachment
Created in NX6.0.0.



License requirements : None

Parameters:
anchorAttachmentanchorattachment

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

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

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.