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

the polygon pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::PolygonPattern:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  SizeOptions { SizeOptionsInscribed, SizeOptionsCircumscribed }
 defines polygon size options for polygon type pattern. More...

Public Member Functions

bool Flip ()
 Returns the flip object for 2D mode.
NXOpen::GeometricUtilities::HorizontalReferenceHorizontalRef ()
 Returns the horizontal reference
Created in NX8.0.0.
NXOpen::ExpressionNumberOfSides ()
 Returns the number of sides for the polygon type pattern will generated in this direction
Created in NX8.0.0.
NXOpen::GeometricUtilities::PolygonPattern::SizeOptions PolygonSizeOption ()
 Returns the polygon size option
Created in NX8.0.0.
NXOpen::GeometricUtilities::PolygonPatternSpacingPolygonSpacing ()
 Returns the polygon spacing of the instances of the pattern
Created in NX8.0.0.
NXOpen::GeometricUtilities::DistancePatternSpacingRadialSpacing ()
 Returns the radial spacing of the instances of the pattern
Created in NX8.0.0.
NXOpen::AxisRotationAxis ()
 Returns the rotation axis for the pattern.
NXOpen::PointRotationCenter ()
 Returns the rotation center for the 2d pattern.
void SetFlip (bool enabled)
 Sets the flip object for 2D mode.
void SetPolygonSizeOption (NXOpen::GeometricUtilities::PolygonPattern::SizeOptions option)
 Sets the polygon size option
Created in NX8.0.0.
void SetRotationAxis (NXOpen::Axis *rotationAxis)
 Sets the rotation axis for the pattern.
void SetRotationCenter (NXOpen::Point *rotationCenter)
 Sets the rotation center for the 2d pattern.
void SetUseRadialDirectionToggle (bool toggle)
 Sets the UseRadialDirection toggle attribute.
bool UseRadialDirectionToggle ()
 Returns the UseRadialDirection toggle attribute.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

the polygon pattern definition.

Allows specification along both the angular and radial directions.
Created in NX8.0.0.


Member Enumeration Documentation

defines polygon size options for polygon type pattern.

Enumerator:
SizeOptionsInscribed 

use inscribed circle to define a polygon

SizeOptionsCircumscribed 

use circumscribed circle to define a polygon


Member Function Documentation

Returns the flip object for 2D mode.

This function gets the flip attribute of the 2D pattern.
Created in NX8.0.0.

License requirements : None

Returns the horizontal reference
Created in NX8.0.0.



License requirements : None

Returns the number of sides for the polygon type pattern will generated in this direction
Created in NX8.0.0.



License requirements : None

Returns the polygon size option
Created in NX8.0.0.



License requirements : None

Returns the polygon spacing of the instances of the pattern
Created in NX8.0.0.



License requirements : None

Returns the radial spacing of the instances of the pattern
Created in NX8.0.0.



License requirements : None

Returns the rotation axis for the pattern.


Created in NX8.0.0.

License requirements : None

Returns the rotation center for the 2d pattern.


Created in NX8.0.0.

License requirements : None

Sets the flip object for 2D mode.

This function gets the flip attribute of the 2D pattern.
Created in NX8.0.0.

License requirements : None

Parameters:
enabledenabled

Sets the polygon size option
Created in NX8.0.0.



License requirements : None

Parameters:
optionoption

Sets the rotation axis for the pattern.


Created in NX8.0.0.

License requirements : None

Parameters:
rotationAxisrotationaxis

Sets the rotation center for the 2d pattern.


Created in NX8.0.0.

License requirements : None

Parameters:
rotationCenterrotationcenter

Sets the UseRadialDirection toggle attribute.

This function gets the UseRadialDirection toggle value
Created in NX8.0.0.

License requirements : None

Parameters:
toggletoggle

Returns the UseRadialDirection toggle attribute.

This function gets the UseRadialDirection toggle value
Created in NX8.0.0.

License requirements : None

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.