NXOpen::GeometricUtilities::PatternSpacing Class Reference

defines the various ways pattern instances can be spaced within the pattern, particularly in the context of the PatternDefinition class. More...

Inheritance diagram for NXOpen::GeometricUtilities::PatternSpacing:

Public Types
enum	SpacingType {   SpacingTypeOffset, SpacingTypeSpan, SpacingTypePitchAndSpan, SpacingTypePitch,   SpacingTypeList, SpacingTypePolygonCountPerSide, SpacingTypePolygonPitchAlongSide }
	defines the type of spacing instances can have within a pattern. More...

Public Member Functions
NXOpen::Expression *	NCopies ()
	Returns the number of copies the pattern will generated in this direction Created in NX7.5.0.
void	SetSpaceType (NXOpen::GeometricUtilities::PatternSpacing::SpacingType spaceType)
	Sets the type of spacing to be used by the pattern Created in NX7.5.0.
NXOpen::GeometricUtilities::PatternSpacing::SpacingType	SpaceType ()
	Returns the type of spacing to be used by the pattern Created in NX7.5.0.
NXOpen::GeometricUtilities::PatternSpacingsList *	SpacingsList ()
	Returns the list of spacings (Expression or OnPathDimBuilder) to be used in this direction Created in NX8.0.0.
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

defines the various ways pattern instances can be spaced within the pattern, particularly in the context of the PatternDefinition class.

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::PatternSpacing::SpacingType

defines the type of spacing instances can have within a pattern.

Enumerator:

SpacingTypeOffset	Specify distance from the origin of one instance to the origin of the next instance.
SpacingTypeSpan	Specify a distance for which all instances should occupy.
SpacingTypePitchAndSpan	Specify distance between instances and distance for all instances, number of copies is calculated.
SpacingTypePitch	This is for pattern fill case. Count is calculated based on the pitch and fill boundary box.
SpacingTypeList	Specify offsets with a list.
SpacingTypePolygonCountPerSide	This is for Polygon type. Specify number of count per side.
SpacingTypePolygonPitchAlongSide	This is for Polygon type. Specify a pitch distance along one side.

Member Function Documentation

NXOpen::Expression* NXOpen::GeometricUtilities::PatternSpacing::NCopies

(

)

Returns the number of copies the pattern will generated in this direction
Created in NX7.5.0.

License requirements : None

void NXOpen::GeometricUtilities::PatternSpacing::SetSpaceType

(

NXOpen::GeometricUtilities::PatternSpacing::SpacingType

spaceType

)

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

License requirements : None

Parameters

spaceType

spacetype

NXOpen::GeometricUtilities::PatternSpacing::SpacingType NXOpen::GeometricUtilities::PatternSpacing::SpaceType

(

)

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

License requirements : None

NXOpen::GeometricUtilities::PatternSpacingsList* NXOpen::GeometricUtilities::PatternSpacing::SpacingsList

(

)

Returns the list of spacings (Expression or OnPathDimBuilder) to be used in this direction
Created in NX8.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::PatternSpacing::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_PatternSpacing.hxx