the rectangular pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::RectangularPattern:

Public Types
enum	SimplifiedLayoutTypes { SimplifiedLayoutTypesSquare, SimplifiedLayoutTypesTriangle, SimplifiedLayoutTypesDiamond }
	defines simplified layout type for linear pattern. More...

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

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

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

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

void	SetSimplifiedLayoutType (NXOpen::GeometricUtilities::RectangularPattern::SimplifiedLayoutTypes type)
	Sets the simplified layout type to be used by the pattern Created in NX8.0.0.

void	SetStaggerType (NXOpen::GeometricUtilities::RectangularPattern::StaggerOptions spaceType)
	Sets the type of stagger to be used by the pattern Created in NX7.5.0.

void	SetUseYDirectionToggle (bool toggle)
	Sets the UseYDirection toggle attribute.

void	SetXDirection (NXOpen::Direction *xDirection)
	Sets the x axis Created in NX7.5.0.

void	SetXFlip (bool flip)
	Sets the XSelection flip attribute.

void	SetXSymmetryToggle (bool toggle)
	Sets the XSymmetry toggle attribute.

void	SetYDirection (NXOpen::Direction *yDirection)
	Sets the y axis, which can be any vector not parallel to the x axis Created in NX7.5.0.

void	SetYFlip (bool flip)
	Sets the YSelection flip attribute.

void	SetYSymmetryToggle (bool toggle)
	Sets the YSymmetry toggle attribute.

NXOpen::GeometricUtilities::RectangularPattern::SimplifiedLayoutTypes	SimplifiedLayoutType ()
	Returns the simplified layout type to be used by the pattern Created in NX8.0.0.

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

bool	UseYDirectionToggle ()
	Returns the UseYDirection toggle attribute.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

NXOpen::Direction *	XDirection ()
	Returns the x axis Created in NX7.5.0.

bool	XFlip ()
	Returns the XSelection flip attribute.

NXOpen::SelectNXObject *	XSelection ()
	Returns the direction object.

NXOpen::GeometricUtilities::DistancePatternSpacing *	XSpacing ()
	Returns the instance spacing along the x axis Created in NX7.5.0.

bool	XSymmetryToggle ()
	Returns the XSymmetry toggle attribute.

NXOpen::Direction *	YDirection ()
	Returns the y axis, which can be any vector not parallel to the x axis Created in NX7.5.0.

bool	YFlip ()
	Returns the YSelection flip attribute.

NXOpen::SelectNXObject *	YSelection ()
	Returns the direction object.

NXOpen::GeometricUtilities::DistancePatternSpacing *	YSpacing ()
	Returns the instance spacing along the y axis Created in NX7.5.0.

bool	YSymmetryToggle ()
	Returns the YSymmetry toggle attribute.

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

Allows specification along two linear axes, which may or may not be orthogonal.
Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::RectangularPattern::SimplifiedLayoutTypes

defines simplified layout type for linear pattern.

Enumerator:

SimplifiedLayoutTypesSquare	Square Layout.
SimplifiedLayoutTypesTriangle	Triangle Layout.
SimplifiedLayoutTypesDiamond	Diamond Layout.

enum NXOpen::GeometricUtilities::RectangularPattern::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.
StaggerOptionsColumn	Stagger column.

Member Function Documentation

bool NXOpen::GeometricUtilities::RectangularPattern::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

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

Returns the horizontal reference
Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::RectangularPattern::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::RectangularPattern::SetSimplifiedLayoutType ( NXOpen::GeometricUtilities::RectangularPattern::SimplifiedLayoutTypes type )

Sets the simplified layout type to be used by the pattern
Created in NX8.0.0.

License requirements : None

Parameters

type type

void NXOpen::GeometricUtilities::RectangularPattern::SetStaggerType ( NXOpen::GeometricUtilities::RectangularPattern::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::RectangularPattern::SetUseYDirectionToggle ( bool toggle )

Sets the UseYDirection toggle attribute.

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

License requirements : None

Parameters

toggle toggle

void NXOpen::GeometricUtilities::RectangularPattern::SetXDirection ( NXOpen::Direction * xDirection )

Sets the x axis
Created in NX7.5.0.

License requirements : None

Parameters

xDirection xdirection

void NXOpen::GeometricUtilities::RectangularPattern::SetXFlip ( bool flip )

Sets the XSelection flip attribute.

This function flips X selection object of the 2D pattern
Created in NX7.5.0.

License requirements : None

Parameters

flip flip

void NXOpen::GeometricUtilities::RectangularPattern::SetXSymmetryToggle ( bool toggle )

Sets the XSymmetry toggle attribute.

This function gets the x Symmetry toggle value
Created in NX7.5.0.

License requirements : None

Parameters

toggle toggle

void NXOpen::GeometricUtilities::RectangularPattern::SetYDirection ( NXOpen::Direction * yDirection )

Sets the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.

License requirements : None

Parameters

yDirection ydirection

void NXOpen::GeometricUtilities::RectangularPattern::SetYFlip ( bool flip )

Sets the YSelection flip attribute.

This function flips Y selection object of the 2D pattern
Created in NX7.5.0.

License requirements : None

Parameters

flip flip

void NXOpen::GeometricUtilities::RectangularPattern::SetYSymmetryToggle ( bool toggle )

Sets the YSymmetry toggle attribute.

This function gets the y Symmetry toggle value
Created in NX7.5.0.

License requirements : None

Parameters

toggle toggle

NXOpen::GeometricUtilities::RectangularPattern::SimplifiedLayoutTypes NXOpen::GeometricUtilities::RectangularPattern::SimplifiedLayoutType ( )

Returns the simplified layout type to be used by the pattern
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::RectangularPattern::StaggerOptions NXOpen::GeometricUtilities::RectangularPattern::StaggerType ( )

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

License requirements : None

bool NXOpen::GeometricUtilities::RectangularPattern::UseYDirectionToggle ( )

Returns the UseYDirection toggle attribute.

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

License requirements : None

virtual bool NXOpen::GeometricUtilities::RectangularPattern::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.

NXOpen::Direction* NXOpen::GeometricUtilities::RectangularPattern::XDirection ( )

Returns the x axis
Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::RectangularPattern::XFlip ( )

Returns the XSelection flip attribute.

This function flips X selection object of the 2D pattern
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::GeometricUtilities::RectangularPattern::XSelection ( )

Returns the direction object.

This function gets X direction object of the 2D pattern. This call will result in an Exception if not called in 2D mode.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::DistancePatternSpacing* NXOpen::GeometricUtilities::RectangularPattern::XSpacing ( )

Returns the instance spacing along the x axis
Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::RectangularPattern::XSymmetryToggle ( )

Returns the XSymmetry toggle attribute.

This function gets the x Symmetry toggle value
Created in NX7.5.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricUtilities::RectangularPattern::YDirection ( )

Returns the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::RectangularPattern::YFlip ( )

Returns the YSelection flip attribute.

This function flips Y selection object of the 2D pattern
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::GeometricUtilities::RectangularPattern::YSelection ( )

Returns the direction object.

This function gets Y direction object of the 2D pattern. This call will result in an Exception if not called in 2D mode.
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::DistancePatternSpacing* NXOpen::GeometricUtilities::RectangularPattern::YSpacing ( )

Returns the instance spacing along the y axis
Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::RectangularPattern::YSymmetryToggle ( )

Returns the YSymmetry toggle attribute.

This function gets the y Symmetry toggle value
Created in NX7.5.0.

License requirements : None

The documentation for this class was generated from the following file:

GeometricUtilities_RectangularPattern.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation