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

the rectangular pattern definition. More...

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

Public Types

enum  SimplifiedLayoutTypes { Square, Triangle, Diamond }
 defines simplified layout type for linear pattern. More...
 
enum  StaggerOptions { None, Row, Column }
 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 bool CreateLastStaggered [get, set]
 Returns or sets the option to generate the last item in a staggered row. More...
 
unsafe
NXOpen.GeometricUtilities.HorizontalReference 
HorizontalRef [get]
 Returns the horizontal reference More...
 
unsafe
NXOpen.GeometricUtilities.RectangularPattern.SimplifiedLayoutTypes 
SimplifiedLayoutType [get, set]
 Returns or sets the simplified layout type to be used by the pattern More...
 
unsafe
NXOpen.GeometricUtilities.RectangularPattern.StaggerOptions 
StaggerType [get, set]
 Returns or sets the type of stagger to be used by the pattern More...
 
unsafe bool UseYDirectionToggle [get, set]
 Returns or sets the UseYDirection toggle attribute. More...
 
unsafe NXOpen.Direction XDirection [get, set]
 Returns or sets the x axis More...
 
unsafe bool XFlip [get, set]
 Returns or sets the XSelection flip attribute. More...
 
unsafe NXOpen.SelectNXObject XSelection [get]
 Returns the direction object. More...
 
unsafe
NXOpen.GeometricUtilities.DistancePatternSpacing 
XSpacing [get]
 Returns the instance spacing along the x axis More...
 
unsafe bool XSymmetryToggle [get, set]
 Returns or sets the XSymmetry toggle attribute. More...
 
unsafe NXOpen.Direction YDirection [get, set]
 Returns or sets the y axis, which can be any vector not parallel to the x axis More...
 
unsafe bool YFlip [get, set]
 Returns or sets the YSelection flip attribute. More...
 
unsafe NXOpen.SelectNXObject YSelection [get]
 Returns the direction object. More...
 
unsafe
NXOpen.GeometricUtilities.DistancePatternSpacing 
YSpacing [get]
 Returns the instance spacing along the y axis More...
 
unsafe bool YSymmetryToggle [get, set]
 Returns or sets the YSymmetry 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 rectangular pattern definition.

Allows specification along two linear axes, which may or may not be orthogonal.

Created in NX7.5.0

Member Enumeration Documentation

defines simplified layout type for linear pattern.

Enumerator
Square 

Square Layout

Triangle 

Triangle Layout

Diamond 

Diamond Layout

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

Column 

Stagger column

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.RectangularPattern.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 bool NXOpen.GeometricUtilities.RectangularPattern.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 NXOpen.GeometricUtilities.HorizontalReference NXOpen.GeometricUtilities.RectangularPattern.HorizontalRef
get

Returns the horizontal reference

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.RectangularPattern.SimplifiedLayoutTypes NXOpen.GeometricUtilities.RectangularPattern.SimplifiedLayoutType
getset

Returns or sets the simplified layout type to be used by the pattern

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.RectangularPattern.StaggerOptions NXOpen.GeometricUtilities.RectangularPattern.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.RectangularPattern.UseYDirectionToggle
getset

Returns or sets the UseYDirection toggle attribute.

This function gets the UseYDirection toggle value

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.GeometricUtilities.RectangularPattern.XDirection
getset

Returns or sets the x axis

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GeometricUtilities.RectangularPattern.XFlip
getset

Returns or sets the XSelection flip attribute.

This function flips X selection object 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.SelectNXObject NXOpen.GeometricUtilities.RectangularPattern.XSelection
get

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.

unsafe NXOpen.GeometricUtilities.DistancePatternSpacing NXOpen.GeometricUtilities.RectangularPattern.XSpacing
get

Returns the instance spacing along the x axis

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.RectangularPattern.XSymmetryToggle
getset

Returns or sets the XSymmetry toggle attribute.

This function gets the x Symmetry toggle value

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.GeometricUtilities.RectangularPattern.YDirection
getset

Returns or sets the y axis, which can be any vector not parallel to the x axis

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GeometricUtilities.RectangularPattern.YFlip
getset

Returns or sets the YSelection flip attribute.

This function flips Y selection object 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.SelectNXObject NXOpen.GeometricUtilities.RectangularPattern.YSelection
get

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.

unsafe NXOpen.GeometricUtilities.DistancePatternSpacing NXOpen.GeometricUtilities.RectangularPattern.YSpacing
get

Returns the instance spacing along the y axis

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.RectangularPattern.YSymmetryToggle
getset

Returns or sets the YSymmetry toggle attribute.

This function gets the y Symmetry 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.