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

Used to create or edit a NXOpen.Weld.DatumSurface feature. More...

Inheritance diagram for NXOpen.Weld.DatumSurfaceBuilder:
NXOpen.Weld.DatumCommonBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Types { Direct, Mirror }
 Settings to indicate the construction type used for the datum surface. More...
 
- Public Types inherited from NXOpen.Weld.DatumCommonBuilder
enum  ControlMethodTypes { PrincipalAxis, UseSectionPlane }
 Settings for the method used to define the control direction. More...
 
enum  CreationDirectionMethods { Default, Opposite }
 Settings to define the creation direction. More...
 
enum  CustomTypes {
  Default, Custom1, Custom2, Custom3,
  Custom4, Custom5, Custom6, Custom7
}
 The custom type of the datum specified for creation. More...
 
enum  SolidTypes { Sphere, Cylinder, Cone }
 Settings for defining the solid type to create for the datum object. More...
 

Public Member Functions

unsafe void InitializeAxis (NXOpen.Point3d approximatePoint)
 Update the axis origin to a point specified, and direction to closest principal axis to face normal. More...
 
unsafe void MoveMinimumDistance ()
 Moves a point to the nearest location on the resting face More...
 
unsafe void UpdateAxisData ()
 Updates data related to the axis. More...
 
unsafe void UpdateWithReferenceDatum ()
 Initialize the builder with the inputs from an existing datum surface locator. More...
 
- Public Member Functions inherited from NXOpen.Weld.DatumCommonBuilder
unsafe void UpdateWithDerivedDatum ()
 Initialize the builder with the inputs from an existing datum. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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.Weld.SelectDatumSurface 
DerivedDatum [get]
 Returns the derived datum More...
 
unsafe double GridSnapTolerance [get, set]
 Returns or sets the grid snap tolerance More...
 
unsafe NXOpen.Plane MirrorPlane [get, set]
 Returns or sets the plane used for mirroring a reference surface locator. More...
 
unsafe NXOpen.ScCollector RestingFace [get]
 Returns the resting face More...
 
unsafe bool SnapPointToGrid [get, set]
 Returns or sets the snap point to grid option. More...
 
unsafe
NXOpen.Weld.DatumSurfaceBuilder.Types 
Type [get, set]
 Returns or sets the construction type used to create the datum surface. More...
 
unsafe double XCoordinate [get, set]
 Returns or sets the x coordinate position for the surface datum location. More...
 
unsafe double YCoordinate [get, set]
 Returns or sets the y coordinate position for the surface datum location More...
 
unsafe double ZCoordinate [get, set]
 Returns or sets the z coordinate position for the datum surface location More...
 
- Properties inherited from NXOpen.Weld.DatumCommonBuilder
unsafe
NXOpen.Assemblies.SelectComponentList 
AdditionalReferences [get]
 Returns the additional references. More...
 
unsafe
NXOpen.Weld.CharacteristicsBuilder 
Characteristics [get]
 Returns the characteristics. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.ControlMethodTypes 
ControlMethod [get, set]
 Returns or sets the control method. More...
 
unsafe bool CreateDirectionVector [get, set]
 Returns or sets the option to control if a reference datum axis should be output with this feature. More...
 
unsafe bool CreatePlane [get, set]
 Returns or sets the option to control if a reference datum plane should be output with the this feature. More...
 
unsafe bool CreatePoint [get, set]
 Returns or sets the option to control if a reference point should be output with this feature. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.CreationDirectionMethods 
CreationDirection [get, set]
 Returns or sets the creation direction. More...
 
unsafe double CustomAboveLength [get, set]
 Returns or sets the length above the datum reference point. More...
 
unsafe double CustomRadius [get, set]
 Returns or sets the radius of the solid sphere, cylinder or cone created. More...
 
unsafe double CustomTotalLength [get, set]
 Returns or sets the total length of the cylinder or cone along the direction axis. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.CustomTypes 
CustomType [get, set]
 Returns or sets the custom datum type. More...
 
unsafe string CustomTypeName [get, set]
 Returns or sets the custom name used to create the datum. More...
 
unsafe bool Derived [get, set]
 Returns or sets the indicator if this should be marked as a derived from another datum. More...
 
unsafe NXOpen.Axis DirectionAxis [get, set]
 Returns or sets the direction axis. More...
 
unsafe double DirectionLength [get, set]
 Returns or sets the length of the datum axis vector created. More...
 
unsafe double ModelingTolerance [get, set]
 Returns or sets the modeling distance tolerance. More...
 
unsafe double PlaneHeight [get, set]
 Returns or sets the plane height along the direction axis. More...
 
unsafe double PlaneWidth [get, set]
 Returns or sets the plane width perpendicular to the direction axis. More...
 
unsafe bool PrincipalAxisX [get, set]
 Returns or sets the principal axis x. More...
 
unsafe bool PrincipalAxisY [get, set]
 Returns or sets the principal axis y. More...
 
unsafe bool PrincipalAxisZ [get, set]
 Returns or sets the principal axis z. More...
 
unsafe bool ProjectAlongDirection [get, set]
 Returns or sets the project along direction. More...
 
unsafe NXOpen.Direction SectionPlaneNormal [get, set]
 Returns or sets the section plane normal. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.SolidTypes 
SolidType [get, set]
 Returns or sets the solid body type specified. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. 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

Used to create or edit a NXOpen.Weld.DatumSurface feature.

To create a new instance of this class, use NXOpen.Weld.WeldManager.CreateDatumSurfaceBuilder

Default values.

Property Value

ControlMethod

PrincipalAxis

CreateDirectionVector

1

CreatePlane

1

CreatePoint

1

Derived

0

DirectionLength

20 (millimeters part), 1.0 (inches part)

GridSnapTolerance

1 (millimeters part), 0.05 (inches part)

ModelingTolerance

0.0254

PlaneHeight

20 (millimeters part), 1.0 (inches part)

PlaneWidth

20 (millimeters part), 1.0 (inches part)

PrincipalAxisX

0

PrincipalAxisY

0

PrincipalAxisZ

0

ProjectAlongDirection

1

SnapPointToGrid

1

XCoordinate

0.0

YCoordinate

0.0

ZCoordinate

0.0

Created in NX8.5.0

Member Enumeration Documentation

Settings to indicate the construction type used for the datum surface.

Enumerator
Direct 

direct location

Mirror 

mirror location

Member Function Documentation

unsafe void NXOpen.Weld.DatumSurfaceBuilder.InitializeAxis ( NXOpen.Point3d  approximatePoint)
inline

Update the axis origin to a point specified, and direction to closest principal axis to face normal.

The point will be adjusted by snapping to a grid.

Created in NX8.5.0

License requirements: ugweld ("UG WELD")

Parameters
approximatePoint
unsafe void NXOpen.Weld.DatumSurfaceBuilder.MoveMinimumDistance ( )
inline

Moves a point to the nearest location on the resting face

Created in NX8.5.0

License requirements: ugweld ("UG WELD")

unsafe void NXOpen.Weld.DatumSurfaceBuilder.UpdateAxisData ( )
inline

Updates data related to the axis.

The origin will be adjusted based on grid snapping, and projection direction. In addition the control direction information will be updated.

Created in NX8.5.0

License requirements: ugweld ("UG WELD")

unsafe void NXOpen.Weld.DatumSurfaceBuilder.UpdateWithReferenceDatum ( )
inline

Initialize the builder with the inputs from an existing datum surface locator.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

Property Documentation

unsafe NXOpen.Weld.SelectDatumSurface NXOpen.Weld.DatumSurfaceBuilder.DerivedDatum
get

Returns the derived datum

Created in NX8.5.0

License requirements: None.

unsafe double NXOpen.Weld.DatumSurfaceBuilder.GridSnapTolerance
getset

Returns or sets the grid snap tolerance

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Plane NXOpen.Weld.DatumSurfaceBuilder.MirrorPlane
getset

Returns or sets the plane used for mirroring a reference surface locator.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.ScCollector NXOpen.Weld.DatumSurfaceBuilder.RestingFace
get

Returns the resting face

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.Weld.DatumSurfaceBuilder.SnapPointToGrid
getset

Returns or sets the snap point to grid option.

Specified locations will be adjusted based on the grid snap tolerance

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Weld.DatumSurfaceBuilder.Types NXOpen.Weld.DatumSurfaceBuilder.Type
getset

Returns or sets the construction type used to create the datum surface.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumSurfaceBuilder.XCoordinate
getset

Returns or sets the x coordinate position for the surface datum location.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumSurfaceBuilder.YCoordinate
getset

Returns or sets the y coordinate position for the surface datum location

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumSurfaceBuilder.ZCoordinate
getset

Returns or sets the z coordinate position for the datum surface location

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")


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