the polygon pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::PolygonPattern:

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::HorizontalReference *	HorizontalRef ()
	Returns the horizontal reference Created in NX8.0.0.

NXOpen::Expression *	NumberOfSides ()
	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::PolygonPatternSpacing *	PolygonSpacing ()
	Returns the polygon spacing of the instances of the pattern Created in NX8.0.0.

NXOpen::GeometricUtilities::DistancePatternSpacing *	RadialSpacing ()
	Returns the radial spacing of the instances of the pattern Created in NX8.0.0.

NXOpen::Axis *	RotationAxis ()
	Returns the rotation axis for the pattern.

NXOpen::Point *	RotationCenter ()
	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.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

the polygon pattern definition.

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

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::PolygonPattern::SizeOptions

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

bool NXOpen::GeometricUtilities::PolygonPattern::Flip ( )

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

NXOpen::GeometricUtilities::HorizontalReference* NXOpen::GeometricUtilities::PolygonPattern::HorizontalRef ( )

Returns the horizontal reference
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::PolygonPattern::NumberOfSides ( )

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

License requirements : None

NXOpen::GeometricUtilities::PolygonPattern::SizeOptions NXOpen::GeometricUtilities::PolygonPattern::PolygonSizeOption ( )

Returns the polygon size option
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PolygonPatternSpacing* NXOpen::GeometricUtilities::PolygonPattern::PolygonSpacing ( )

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

License requirements : None

NXOpen::GeometricUtilities::DistancePatternSpacing* NXOpen::GeometricUtilities::PolygonPattern::RadialSpacing ( )

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

License requirements : None

NXOpen::Axis* NXOpen::GeometricUtilities::PolygonPattern::RotationAxis ( )

Returns the rotation axis for the pattern.

Created in NX8.0.0.

License requirements : None

NXOpen::Point* NXOpen::GeometricUtilities::PolygonPattern::RotationCenter ( )

Returns the rotation center for the 2d pattern.

Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PolygonPattern::SetFlip ( bool enabled )

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

enabled enabled

void NXOpen::GeometricUtilities::PolygonPattern::SetPolygonSizeOption ( NXOpen::GeometricUtilities::PolygonPattern::SizeOptions option )

Sets the polygon size option
Created in NX8.0.0.

License requirements : None

Parameters

option option

void NXOpen::GeometricUtilities::PolygonPattern::SetRotationAxis ( NXOpen::Axis * rotationAxis )

Sets the rotation axis for the pattern.

Created in NX8.0.0.

License requirements : None

Parameters

rotationAxis rotationaxis

void NXOpen::GeometricUtilities::PolygonPattern::SetRotationCenter ( NXOpen::Point * rotationCenter )

Sets the rotation center for the 2d pattern.

Created in NX8.0.0.

License requirements : None

Parameters

rotationCenter rotationcenter

void NXOpen::GeometricUtilities::PolygonPattern::SetUseRadialDirectionToggle ( bool toggle )

Sets the UseRadialDirection toggle attribute.

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

License requirements : None

Parameters

toggle toggle

bool NXOpen::GeometricUtilities::PolygonPattern::UseRadialDirectionToggle ( )

Returns the UseRadialDirection toggle attribute.

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

License requirements : None

virtual bool NXOpen::GeometricUtilities::PolygonPattern::Validate ( )

virtual

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:

GeometricUtilities_PolygonPattern.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation