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

the polygon pattern definition. More...

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

Public Types

enum  SizeOptions { Inscribed, Circumscribed }
 defines polygon size options for polygon type 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 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 NXOpen.Expression NumberOfSides [get]
 Returns the number of sides for the polygon type pattern will generated in this direction More...
 
unsafe
NXOpen.GeometricUtilities.PolygonPattern.SizeOptions 
PolygonSizeOption [get, set]
 Returns or sets the polygon size option More...
 
unsafe
NXOpen.GeometricUtilities.PolygonPatternSpacing 
PolygonSpacing [get]
 Returns the polygon spacing of the instances of the pattern 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 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 polygon pattern definition.

Allows specification along both the angular and radial directions.

Created in NX8.0.0

Member Enumeration Documentation

defines polygon size options for polygon type pattern.

Enumerator
Inscribed 

use inscribed circle to define a polygon

Circumscribed 

use circumscribed circle to define a polygon

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.PolygonPattern.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.PolygonPattern.Flip
getset

Returns or sets the flip object for 2D mode.

This function gets the flip attribute of 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.HorizontalReference NXOpen.GeometricUtilities.PolygonPattern.HorizontalRef
get

Returns the horizontal reference

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.PolygonPattern.NumberOfSides
get

Returns the number of sides for the polygon type pattern will generated in this direction

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.PolygonPattern.SizeOptions NXOpen.GeometricUtilities.PolygonPattern.PolygonSizeOption
getset

Returns or sets the polygon size option

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricUtilities.PolygonPatternSpacing NXOpen.GeometricUtilities.PolygonPattern.PolygonSpacing
get

Returns the polygon spacing of the instances of the pattern

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.DistancePatternSpacing NXOpen.GeometricUtilities.PolygonPattern.RadialSpacing
get

Returns the radial spacing of the instances of the pattern

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Axis NXOpen.GeometricUtilities.PolygonPattern.RotationAxis
getset

Returns or sets the rotation axis for the pattern.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.GeometricUtilities.PolygonPattern.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 bool NXOpen.GeometricUtilities.PolygonPattern.UseRadialDirectionToggle
getset

Returns or sets the UseRadialDirection toggle attribute.

This function gets the UseRadialDirection toggle value

Created in NX8.0.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.