NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.GeometricUtilities.CircularPattern Class Reference

the circular pattern definition. More...

Inheritance diagram for NXOpen.GeometricUtilities.CircularPattern:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  StaggerOptions { None, Row }
 defines any stagger to be defined on the pattern. More...
 

Public Member Functions

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.AngularPatternSpacing 
AngularSpacing [get]
 Returns the angular spacing of the instances of the pattern More...
 
unsafe NXOpen.SelectNXObject CenterPoint [get]
 Returns the center point object for 2D mode. More...
 
unsafe bool CreateLastStaggered [get, set]
 Returns or sets the option to generate the last item in a staggered row. More...
 
unsafe bool Flip [get, set]
 Returns or sets the flip object for 2D mode. More...
 
unsafe
NXOpen.GeometricUtilities.HorizontalReference 
HorizontalRef [get]
 Returns the horizontal reference More...
 
unsafe bool IncludeSeedToggle [get, set]
 Returns or sets the IncludeSeed toggle attribute. More...
 
unsafe
NXOpen.GeometricUtilities.DistancePatternSpacing 
RadialSpacing [get]
 Returns the radial spacing of the instances of the pattern More...
 
unsafe NXOpen.Axis RotationAxis [get, set]
 Returns or sets the rotation axis for the pattern. More...
 
unsafe NXOpen.Point RotationCenter [get, set]
 Returns or sets the rotation center for the 2d pattern. More...
 
unsafe
NXOpen.GeometricUtilities.CircularPattern.StaggerOptions 
StaggerType [get, set]
 Returns or sets the type of stagger to be used by the pattern More...
 
unsafe bool UseRadialDirectionToggle [get, set]
 Returns or sets the UseRadialDirection toggle attribute. 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

the circular pattern definition.

Allows specification along both the angular and radial directions.

Created in NX7.5.0

Member Enumeration Documentation

defines any stagger to be defined on the pattern.

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

Enumerator
None 

No stagger applied

Row 

Stagger row

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.CircularPattern.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.AngularPatternSpacing NXOpen.GeometricUtilities.CircularPattern.AngularSpacing
get

Returns the angular spacing of the instances of the pattern

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.SelectNXObject NXOpen.GeometricUtilities.CircularPattern.CenterPoint
get

Returns the center point object for 2D mode.

This function gets center point object of the 2D pattern

Created in NX7.5.0

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

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.CircularPattern.CreateLastStaggered
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GeometricUtilities.CircularPattern.Flip
getset

Returns or sets the flip object for 2D mode.

This function gets the flip attribute of the 2D pattern.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.HorizontalReference NXOpen.GeometricUtilities.CircularPattern.HorizontalRef
get

Returns the horizontal reference

Created in NX8.0.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.CircularPattern.IncludeSeedToggle
getset

Returns or sets the IncludeSeed toggle attribute.

This function gets the IncludeSeed toggle value

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.DistancePatternSpacing NXOpen.GeometricUtilities.CircularPattern.RadialSpacing
get

Returns the radial spacing of the instances of the pattern

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Axis NXOpen.GeometricUtilities.CircularPattern.RotationAxis
getset

Returns or sets the rotation axis for the pattern.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.GeometricUtilities.CircularPattern.RotationCenter
getset

Returns or sets the rotation center for the 2d pattern.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.CircularPattern.StaggerOptions NXOpen.GeometricUtilities.CircularPattern.StaggerType
getset

Returns or sets the type of stagger to be used by the pattern

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GeometricUtilities.CircularPattern.UseRadialDirectionToggle
getset

Returns or sets the UseRadialDirection toggle attribute.

This function gets the UseRadialDirection toggle value

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.