the circular pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::CircularPattern:

Public Types
enum	StaggerOptions { StaggerOptionsNone, StaggerOptionsRow }
	defines any stagger to be defined on the pattern. More...

Public Member Functions
NXOpen::GeometricUtilities::AngularPatternSpacing *	AngularSpacing ()
	Returns the angular spacing of the instances of the pattern Created in NX7.5.0.

NXOpen::SelectNXObject *	CenterPoint ()
	Returns the center point object for 2D mode.

bool	CreateLastStaggered ()
	Returns the option to generate the last item in a staggered row.

bool	Flip ()
	Returns the flip object for 2D mode.

NXOpen::GeometricUtilities::HorizontalReference *	HorizontalRef ()
	Returns the horizontal reference Created in NX8.0.0.

bool	IncludeSeedToggle ()
	Returns the IncludeSeed toggle attribute.

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

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

NXOpen::Point *	RotationCenter ()
	Returns the rotation center for the 2d pattern.

void	SetCreateLastStaggered (bool create)
	Sets the option to generate the last item in a staggered row.

void	SetFlip (bool enabled)
	Sets the flip object for 2D mode.

void	SetIncludeSeedToggle (bool toggle)
	Sets the IncludeSeed toggle attribute.

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	SetStaggerType (NXOpen::GeometricUtilities::CircularPattern::StaggerOptions spaceType)
	Sets the type of stagger to be used by the pattern Created in NX7.5.0.

void	SetUseRadialDirectionToggle (bool toggle)
	Sets the UseRadialDirection toggle attribute.

NXOpen::GeometricUtilities::CircularPattern::StaggerOptions	StaggerType ()
	Returns the type of stagger to be used by the pattern Created in NX7.5.0.

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 circular pattern definition.

Allows specification along both the angular and radial directions.
Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::CircularPattern::StaggerOptions

defines any stagger to be defined on the pattern.

Stagger values are used to offset to every other row/column of the pattern.

Enumerator:

StaggerOptionsNone	No stagger applied.
StaggerOptionsRow	Stagger row.

Member Function Documentation

NXOpen::GeometricUtilities::AngularPatternSpacing* NXOpen::GeometricUtilities::CircularPattern::AngularSpacing ( )

Returns the angular spacing of the instances of the pattern
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::GeometricUtilities::CircularPattern::CenterPoint ( )

Returns the center point object for 2D mode.

This function gets center point object of the 2D pattern

Deprecated:: Deprecated in NX8.0.0. Use GeometricUtilities::CircularPattern::RotationCenter instead.

Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::CircularPattern::CreateLastStaggered ( )

Returns the option to generate the last item in a staggered row.

If 'true' the pattern will be narrower on rows that have been staggered.
Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::CircularPattern::Flip ( )

Returns the flip object for 2D mode.

This function gets the flip attribute of the 2D pattern.
Created in NX7.5.0.

License requirements : None

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

Returns the horizontal reference
Created in NX8.0.0.

License requirements : None

bool NXOpen::GeometricUtilities::CircularPattern::IncludeSeedToggle ( )

Returns the IncludeSeed toggle attribute.

This function gets the IncludeSeed toggle value
Created in NX7.5.0.

License requirements : None

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

Returns the radial spacing of the instances of the pattern
Created in NX7.5.0.

License requirements : None

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

Returns the rotation axis for the pattern.

Created in NX7.5.0.

License requirements : None

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

Returns the rotation center for the 2d pattern.

Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::CircularPattern::SetCreateLastStaggered ( bool create )

Sets the option to generate the last item in a staggered row.

If 'true' the pattern will be narrower on rows that have been staggered.
Created in NX7.5.0.

License requirements : None

Parameters

create create

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

Sets the flip object for 2D mode.

This function gets the flip attribute of the 2D pattern.
Created in NX7.5.0.

License requirements : None

Parameters

enabled enabled

void NXOpen::GeometricUtilities::CircularPattern::SetIncludeSeedToggle ( bool toggle )

Sets the IncludeSeed toggle attribute.

This function gets the IncludeSeed toggle value
Created in NX7.5.0.

License requirements : None

Parameters

toggle toggle

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

Sets the rotation axis for the pattern.

Created in NX7.5.0.

License requirements : None

Parameters

rotationAxis rotationaxis

void NXOpen::GeometricUtilities::CircularPattern::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::CircularPattern::SetStaggerType ( NXOpen::GeometricUtilities::CircularPattern::StaggerOptions spaceType )

Sets the type of stagger to be used by the pattern
Created in NX7.5.0.

License requirements : None

Parameters

spaceType spacetype

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

Sets the UseRadialDirection toggle attribute.

This function gets the UseRadialDirection toggle value
Created in NX7.5.0.

License requirements : None

Parameters

toggle toggle

NXOpen::GeometricUtilities::CircularPattern::StaggerOptions NXOpen::GeometricUtilities::CircularPattern::StaggerType ( )

Returns the type of stagger to be used by the pattern
Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::CircularPattern::UseRadialDirectionToggle ( )

Returns the UseRadialDirection toggle attribute.

This function gets the UseRadialDirection toggle value
Created in NX7.5.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::CircularPattern::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_CircularPattern.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation