pattern spacing for several pattern based commands. More...

Inheritance diagram for NXOpen.GeometricUtilities.PatternDefinition:

Public Types
enum	PatternEnum { Linear, Circular, Polygon, Spiral, AlongPath, General, Reference, Mirror, Helix }
	pattern types available. More...

Public Member Functions
unsafe NXOpen.GeometricUtilities.PatternClockingBuilder	CreateClockingBuilder (int ix, int iy)
	Creates a pattern clocking object More...

unsafe NXOpen.GeometricUtilities.PatternInstanceEditBuilder	CreatePatternInstanceEditBuilder ()
	This is the default creator for NXOpen.GeometricUtilities.PatternInstanceEditBuilder . More...

unsafe NXOpen.GeometricUtilities.PatternClocking	GetClocking (int index1, int index2)
	Returns the clocking data for a NXOpen.GeometricUtilities.PatternDefinition instance More...

unsafe bool	GetDeleteState (int index1, int index2)
	Gets the delete state for the instance at the specified indicies. More...

unsafe bool	GetSuppressState (int index1, int index2)
	Gets the suppress state for the instance at the specified indicies. More...

unsafe void	RemoveClocking (int index1, int index2)
	Removes clocking from pattern definition instance More...

unsafe void	RemoveVariance (int index1, int index2)
	Removes variance from pattern definition instance More...

unsafe void	SetDeleteState (int index1, int index2, bool deleteState)
	Sets the delete state for the instance at the specified indicies. More...

unsafe void	SetSpreadsheetData (double[] spreadsheetTableArray, double[] locationTableArray, bool[] defaultTableArray)
	Sets the spreadsheet data More...

unsafe void	SetSuppressState (int index1, int index2, bool suppressState)
	Sets the suppress state for the instance at the specified indicies. More...

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.GeometricUtilities.AlongPathPattern	AlongPathDefinition `[get]`
	Returns the along path definition. More...

unsafe NXOpen.GeometricUtilities.CircularPattern	CircularDefinition `[get]`
	Returns the circular definition. More...

unsafe bool	FrameOnlyToggle `[get, set]`
	Returns or sets the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary. More...

unsafe NXOpen.GeometricUtilities.GeneralPattern	GeneralDefinition `[get]`
	Returns the general definition. More...

unsafe NXOpen.GeometricUtilities.HelixPattern	HelixDefinition `[get]`
	Returns the helix definition. More...

unsafe NXOpen.GeometricUtilities.MirrorPattern	MirrorDefinition `[get]`
	Returns the mirror definition. More...

unsafe NXOpen.GeometricUtilities.PatternFill	PatternFill `[get]`
	Returns the pattern fill definition. More...

unsafe NXOpen.GeometricUtilities.PatternIncrementsBuilder	PatternIncrementsBuilder `[get]`
	Returns the pattern increments definition. More...

unsafe NXOpen.GeometricUtilities.PatternOrientation	PatternOrientation `[get]`
	Returns the pattern orientation definition. More...

unsafe NXOpen.GeometricUtilities.PatternDefinition.PatternEnum	PatternType `[get, set]`
	Returns or sets the pattern type More...

unsafe NXOpen.GeometricUtilities.PolygonPattern	PolygonDefinition `[get]`
	Returns the polygon definition. More...

unsafe NXOpen.GeometricUtilities.RectangularPattern	RectangularDefinition `[get]`
	Returns the linear definition. More...

unsafe NXOpen.GeometricUtilities.ReferencePattern	ReferenceDefinition `[get]`
	Returns the reference definition. More...

unsafe bool	SeedOnlyToggle `[get, set]`
	Returns or sets the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction. More...

unsafe NXOpen.GeometricUtilities.SpiralPattern	SpiralDefinition `[get]`
	Returns the spiral definition. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

pattern spacing for several pattern based commands.

See PatternEnum definition below for a listing of the various pattern definitions available.

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.GeometricUtilities.PatternDefinition.PatternEnum

pattern types available.

For details on the interface of each type, visit the corresponding definition class for each type.

Enumerator
Linear	pattern along single linear direction.
Circular	pattern in angular and radial directions.
Polygon	polygon pattern.
Spiral	spiral pattern.
AlongPath	pattern along a section path.
General	general pattern.
Reference	reference pattern.
Mirror	mirror pattern.
Helix	helix pattern.

Member Function Documentation

unsafe NXOpen.GeometricUtilities.PatternClockingBuilder NXOpen.GeometricUtilities.PatternDefinition.CreateClockingBuilder	(	int	ix,
		int	iy
	)

inline

Creates a pattern clocking object

Created in NX7.5.0

License requirements: None.

Parameters

ix	x index of instance to initialize to
iy	y index of instance to initialize to

Returns

unsafe NXOpen.GeometricUtilities.PatternInstanceEditBuilder NXOpen.GeometricUtilities.PatternDefinition.CreatePatternInstanceEditBuilder ( )

inline

This is the default creator for NXOpen.GeometricUtilities.PatternInstanceEditBuilder .

Created in NX7.5.0

License requirements: None.

Returns

unsafe NXOpen.GeometricUtilities.PatternClocking NXOpen.GeometricUtilities.PatternDefinition.GetClocking	(	int	index1,
		int	index2
	)

inline

Returns the clocking data for a NXOpen.GeometricUtilities.PatternDefinition instance

Created in NX7.5.0

Deprecated in NX8.0.0. Use NXOpen.GeometricUtilities.PatternDefinition.CreateClockingBuilder instead.

License requirements: None.

Parameters

index1	First index into pattern instance array
index2	Second index into pattern instance array

Returns

unsafe bool NXOpen.GeometricUtilities.PatternDefinition.GetDeleteState	(	int	index1,
		int	index2
	)

inline

Gets the delete state for the instance at the specified indicies.

Created in NX8.0.0

License requirements: None.

Parameters

index1	First index of instance
index2	Second index of instance

Returns

unsafe bool NXOpen.GeometricUtilities.PatternDefinition.GetSuppressState	(	int	index1,
		int	index2
	)

inline

Gets the suppress state for the instance at the specified indicies.

Created in NX7.5.0

License requirements: None.

Parameters

index1	First index of instance
index2	Second index of instance

Returns

unsafe void NXOpen.GeometricUtilities.PatternDefinition.RemoveClocking	(	int	index1,
		int	index2
	)

inline

Removes clocking from pattern definition instance

Created in NX7.5.0

License requirements: None.

Parameters

index1	First index into pattern instance array
index2	Second index into pattern instance array

unsafe void NXOpen.GeometricUtilities.PatternDefinition.RemoveVariance	(	int	index1,
		int	index2
	)

inline

Removes variance from pattern definition instance

Created in NX8.0.0

License requirements: None.

Parameters

index1	First index into pattern instance array
index2	Second index into pattern instance array

unsafe void NXOpen.GeometricUtilities.PatternDefinition.SetDeleteState	(	int	index1,
		int	index2,
		bool	deleteState
	)

inline

Sets the delete state for the instance at the specified indicies.

Created in NX8.0.0

License requirements: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

index1	First index of instance
index2	Second index of instance
deleteState	Input suppress state

unsafe void NXOpen.GeometricUtilities.PatternDefinition.SetSpreadsheetData	(	double[]	spreadsheetTableArray,
		double[]	locationTableArray,
		bool[]	defaultTableArray
	)

inline

Sets the spreadsheet data

Created in NX8.0.0

License requirements: None.

Parameters

spreadsheetTableArray
locationTableArray
defaultTableArray

unsafe void NXOpen.GeometricUtilities.PatternDefinition.SetSuppressState	(	int	index1,
		int	index2,
		bool	suppressState
	)

inline

Sets the suppress state for the instance at the specified indicies.

Created in NX7.5.0

License requirements: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

index1	First index of instance
index2	Second index of instance
suppressState	Input suppress state

unsafe bool NXOpen.GeometricUtilities.PatternDefinition.Validate ( )

inline

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.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.GeometricUtilities.AlongPathPattern NXOpen.GeometricUtilities.PatternDefinition.AlongPathDefinition

get

Returns the along path definition.

See AlongPathPattern for details.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.CircularPattern NXOpen.GeometricUtilities.PatternDefinition.CircularDefinition

get

Returns the circular definition.

See CircularPattern for details.

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.PatternDefinition.FrameOnlyToggle

getset

Returns or sets the frameOnlyToggle, a logical flag to indicate if the we need only instances on the boundary.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.GeneralPattern NXOpen.GeometricUtilities.PatternDefinition.GeneralDefinition

get

Returns the general definition.

See GeneralPattern for details.

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.HelixPattern NXOpen.GeometricUtilities.PatternDefinition.HelixDefinition

get

Returns the helix definition.

See HelixPattern for details.

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.MirrorPattern NXOpen.GeometricUtilities.PatternDefinition.MirrorDefinition

get

Returns the mirror definition.

See MirrorPattern for details.

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.PatternFill NXOpen.GeometricUtilities.PatternDefinition.PatternFill

get

Returns the pattern fill definition.

See PatternFill for details.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.PatternIncrementsBuilder NXOpen.GeometricUtilities.PatternDefinition.PatternIncrementsBuilder

get

Returns the pattern increments definition.

See NXOpen.GeometricUtilities.PatternIncrementsBuilder for details.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.PatternOrientation NXOpen.GeometricUtilities.PatternDefinition.PatternOrientation

get

Returns the pattern orientation definition.

See PatternOrientation for details.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.PatternDefinition.PatternEnum NXOpen.GeometricUtilities.PatternDefinition.PatternType

getset

Returns or sets the pattern type

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.PolygonPattern NXOpen.GeometricUtilities.PatternDefinition.PolygonDefinition

get

Returns the polygon definition.

See PolygonPattern for details.

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.RectangularPattern NXOpen.GeometricUtilities.PatternDefinition.RectangularDefinition

get

Returns the linear definition.

See LinearPattern for details.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.ReferencePattern NXOpen.GeometricUtilities.PatternDefinition.ReferenceDefinition

get

Returns the reference definition.

See ReferencePattern for details.

Created in NX8.0.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.PatternDefinition.SeedOnlyToggle

getset

Returns or sets the seedOnlyToggle, a logical flag to indicate if the we need only instances for the seed along the second direction.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.SpiralPattern NXOpen.GeometricUtilities.PatternDefinition.SpiralDefinition

get

Returns the spiral definition.

See SpiralPattern for details.

Created in NX8.0.0

License requirements: None.

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

GeometricUtilities_PatternDefinition.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation