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

Inheritance diagram for NXOpen::Weld::DatumSurfaceBuilder:

Public Types
enum	Types { TypesDirect, TypesMirror }
	Settings to indicate the construction type used for the datum surface. More...

Public Types inherited from NXOpen::Weld::DatumCommonBuilder
enum	ControlMethodTypes { ControlMethodTypesPrincipalAxis, ControlMethodTypesUseSectionPlane }
	Settings for the method used to define the control direction. More...

enum	CreationDirectionMethods { CreationDirectionMethodsDefault, CreationDirectionMethodsOpposite }
	Settings to define the creation direction. More...

enum	CustomTypes { CustomTypesDefault, CustomTypesCustom1, CustomTypesCustom2, CustomTypesCustom3, CustomTypesCustom4, CustomTypesCustom5, CustomTypesCustom6, CustomTypesCustom7 }
	The custom type of the datum specified for creation. More...

enum	SolidTypes { SolidTypesSphere, SolidTypesCylinder, SolidTypesCone }
	Settings for defining the solid type to create for the datum object. More...

Public Member Functions
NXOpen::Weld::SelectDatumSurface *	DerivedDatum ()
	Returns the derived datum Created in NX8.5.0.

double	GridSnapTolerance ()
	Returns the grid snap tolerance Created in NX8.5.0.

void	InitializeAxis (const NXOpen::Point3d &approximatePoint)
	Update the axis origin to a point specified, and direction to closest principal axis to face normal.

NXOpen::Plane *	MirrorPlane ()
	Returns the plane used for mirroring a reference surface locator.

void	MoveMinimumDistance ()
	Moves a point to the nearest location on the resting face Created in NX8.5.0.

NXOpen::ScCollector *	RestingFace ()
	Returns the resting face Created in NX8.5.0.

void	SetGridSnapTolerance (double gridSnapTolerance)
	Sets the grid snap tolerance Created in NX8.5.0.

void	SetMirrorPlane (NXOpen::Plane *mirrorPlane)
	Sets the plane used for mirroring a reference surface locator.

void	SetSnapPointToGrid (bool snapPointToGrid)
	Sets the snap point to grid option.

void	SetType (NXOpen::Weld::DatumSurfaceBuilder::Types type)
	Sets the construction type used to create the datum surface.

void	SetXCoordinate (double xCoordinate)
	Sets the x coordinate position for the surface datum location.

void	SetYCoordinate (double yCoordinate)
	Sets the y coordinate position for the surface datum location Created in NX8.5.0.

void	SetZCoordinate (double zCoordinate)
	Sets the z coordinate position for the datum surface location Created in NX8.5.0.

bool	SnapPointToGrid ()
	Returns the snap point to grid option.

NXOpen::Weld::DatumSurfaceBuilder::Types	Type ()
	Returns the construction type used to create the datum surface.

void	UpdateAxisData ()
	Updates data related to the axis.

void	UpdateWithReferenceDatum ()
	Initialize the builder with the inputs from an existing datum surface locator.

double	XCoordinate ()
	Returns the x coordinate position for the surface datum location.

double	YCoordinate ()
	Returns the y coordinate position for the surface datum location Created in NX8.5.0.

double	ZCoordinate ()
	Returns the z coordinate position for the datum surface location Created in NX8.5.0.

Public Member Functions inherited from NXOpen::Weld::DatumCommonBuilder
NXOpen::Assemblies::SelectComponentList *	AdditionalReferences ()
	Returns the additional references.

NXOpen::Weld::CharacteristicsBuilder *	Characteristics ()
	Returns the characteristics.

NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes	ControlMethod ()
	Returns the control method.

bool	CreateDirectionVector ()
	Returns the option to control if a reference datum axis should be output with this feature.

bool	CreatePlane ()
	Returns the option to control if a reference datum plane should be output with the this feature.

bool	CreatePoint ()
	Returns the option to control if a reference point should be output with this feature.

NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods	CreationDirection ()
	Returns the creation direction.

double	CustomAboveLength ()
	Returns the length above the datum reference point.

double	CustomRadius ()
	Returns the radius of the solid sphere, cylinder or cone created.

double	CustomTotalLength ()
	Returns the total length of the cylinder or cone along the direction axis.

NXOpen::Weld::DatumCommonBuilder::CustomTypes	CustomType ()
	Returns the custom datum type.

NXString	CustomTypeName ()
	Returns the custom name used to create the datum.

bool	Derived ()
	Returns the indicator if this should be marked as a derived from another datum.

NXOpen::Axis *	DirectionAxis ()
	Returns the direction axis.

double	DirectionLength ()
	Returns the length of the datum axis vector created.

double	ModelingTolerance ()
	Returns the modeling distance tolerance.

double	PlaneHeight ()
	Returns the plane height along the direction axis.

double	PlaneWidth ()
	Returns the plane width perpendicular to the direction axis.

bool	PrincipalAxisX ()
	Returns the principal axis x.

bool	PrincipalAxisY ()
	Returns the principal axis y.

bool	PrincipalAxisZ ()
	Returns the principal axis z.

bool	ProjectAlongDirection ()
	Returns the project along direction.

NXOpen::Direction *	SectionPlaneNormal ()
	Returns the section plane normal.

void	SetControlMethod (NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes controlMethod)
	Sets the control method.

void	SetCreateDirectionVector (bool createDirectionVector)
	Sets the option to control if a reference datum axis should be output with this feature.

void	SetCreatePlane (bool createPlane)
	Sets the option to control if a reference datum plane should be output with the this feature.

void	SetCreatePoint (bool createPoint)
	Sets the option to control if a reference point should be output with this feature.

void	SetCreationDirection (NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods creationDirection)
	Sets the creation direction.

void	SetCustomAboveLength (double directionLength)
	Sets the length above the datum reference point.

void	SetCustomRadius (double customRadius)
	Sets the radius of the solid sphere, cylinder or cone created.

void	SetCustomTotalLength (double customTotalLength)
	Sets the total length of the cylinder or cone along the direction axis.

void	SetCustomType (NXOpen::Weld::DatumCommonBuilder::CustomTypes customType)
	Sets the custom datum type.

void	SetCustomTypeName (const NXString &customTypeName)
	Sets the custom name used to create the datum.

void	SetCustomTypeName (const char *customTypeName)
	Sets the custom name used to create the datum.

void	SetDerived (bool derived)
	Sets the indicator if this should be marked as a derived from another datum.

void	SetDirectionAxis (NXOpen::Axis *directionAxis)
	Sets the direction axis.

void	SetDirectionLength (double directionLength)
	Sets the length of the datum axis vector created.

void	SetModelingTolerance (double modelingTolerance)
	Sets the modeling distance tolerance.

void	SetPlaneHeight (double planeHeight)
	Sets the plane height along the direction axis.

void	SetPlaneWidth (double planeWidth)
	Sets the plane width perpendicular to the direction axis.

void	SetPrincipalAxisX (bool principalAxisX)
	Sets the principal axis x.

void	SetPrincipalAxisY (bool principalAxisY)
	Sets the principal axis y.

void	SetPrincipalAxisZ (bool principalAxisZ)
	Sets the principal axis z.

void	SetProjectAlongDirection (bool projectAlongDirection)
	Sets the project along direction.

void	SetSectionPlaneNormal (NXOpen::Direction *sectionPlaneNormal)
	Sets the section plane normal.

void	SetSolidType (NXOpen::Weld::DatumCommonBuilder::SolidTypes solidType)
	Sets the solid body type specified.

NXOpen::Weld::DatumCommonBuilder::SolidTypes	SolidType ()
	Returns the solid body type specified.

void	UpdateWithDerivedDatum ()
	Initialize the builder with the inputs from an existing datum.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

To create a new instance of this class, use 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

enum NXOpen::Weld::DatumSurfaceBuilder::Types

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

Enumerator:

TypesDirect	direct location
TypesMirror	mirror location

Member Function Documentation

NXOpen::Weld::SelectDatumSurface* NXOpen::Weld::DatumSurfaceBuilder::DerivedDatum ( )

Returns the derived datum
Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumSurfaceBuilder::GridSnapTolerance ( )

Returns the grid snap tolerance
Created in NX8.5.0.

License requirements : None

void NXOpen::Weld::DatumSurfaceBuilder::InitializeAxis ( const NXOpen::Point3d & approximatePoint )

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 approximatepoint

NXOpen::Plane* NXOpen::Weld::DatumSurfaceBuilder::MirrorPlane ( )

Returns the plane used for mirroring a reference surface locator.

Created in NX9.0.0.

License requirements : None

void NXOpen::Weld::DatumSurfaceBuilder::MoveMinimumDistance ( )

Moves a point to the nearest location on the resting face
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

NXOpen::ScCollector* NXOpen::Weld::DatumSurfaceBuilder::RestingFace ( )

Returns the resting face
Created in NX8.5.0.

License requirements : None

void NXOpen::Weld::DatumSurfaceBuilder::SetGridSnapTolerance ( double gridSnapTolerance )

Sets the grid snap tolerance
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

gridSnapTolerance gridsnaptolerance

void NXOpen::Weld::DatumSurfaceBuilder::SetMirrorPlane ( NXOpen::Plane * mirrorPlane )

Sets the plane used for mirroring a reference surface locator.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

mirrorPlane mirrorplane

void NXOpen::Weld::DatumSurfaceBuilder::SetSnapPointToGrid ( bool snapPointToGrid )

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 : ugweld ("UG WELD")

Parameters

snapPointToGrid snappointtogrid

void NXOpen::Weld::DatumSurfaceBuilder::SetType ( NXOpen::Weld::DatumSurfaceBuilder::Types type )

Sets the construction type used to create the datum surface.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

type type

void NXOpen::Weld::DatumSurfaceBuilder::SetXCoordinate ( double xCoordinate )

Sets the x coordinate position for the surface datum location.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

xCoordinate xcoordinate

void NXOpen::Weld::DatumSurfaceBuilder::SetYCoordinate ( double yCoordinate )

Sets the y coordinate position for the surface datum location
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

yCoordinate ycoordinate

void NXOpen::Weld::DatumSurfaceBuilder::SetZCoordinate ( double zCoordinate )

Sets the z coordinate position for the datum surface location
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

zCoordinate zcoordinate

bool NXOpen::Weld::DatumSurfaceBuilder::SnapPointToGrid ( )

Returns the snap point to grid option.

Specified locations will be adjusted based on the grid snap tolerance
Created in NX8.5.0.

License requirements : None

NXOpen::Weld::DatumSurfaceBuilder::Types NXOpen::Weld::DatumSurfaceBuilder::Type ( )

Returns the construction type used to create the datum surface.

Created in NX9.0.0.

License requirements : None

void NXOpen::Weld::DatumSurfaceBuilder::UpdateAxisData ( )

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")

void NXOpen::Weld::DatumSurfaceBuilder::UpdateWithReferenceDatum ( )

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

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

double NXOpen::Weld::DatumSurfaceBuilder::XCoordinate ( )

Returns the x coordinate position for the surface datum location.

Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumSurfaceBuilder::YCoordinate ( )

Returns the y coordinate position for the surface datum location
Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumSurfaceBuilder::ZCoordinate ( )

Returns the z coordinate position for the datum surface location
Created in NX8.5.0.

License requirements : None

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

Weld_DatumSurfaceBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation