Represents a GeometricUtilities::AlignmentMethodBuilder. More...

Inheritance diagram for NXOpen::GeometricUtilities::AlignmentMethodBuilder:

Public Types
enum	AlignFillerSurfaceType { AlignFillerSurfaceTypeNoFiller, AlignFillerSurfaceTypeCone, AlignFillerSurfaceTypeCylinder, AlignFillerSurfaceTypeTrimmed }
	Filler surface types. More...

enum	Type { TypeParameter, TypeArcLength, TypePoints, TypeDistance, TypeAngle, TypeSpineCurve, TypeSplinePoints, TypeSegments, TypeDevelopable }
	Alignment types supported. More...

Public Member Functions
int	AddPoint (NXOpen::GeometricUtilities::OnPathDimensionBuilder *alignPoint)
	Insert a given point, and create corresponding points on other sections.

void	AddSection (int sectionIndex, NXOpen::Section *sec)
	Add a section at the given index among existing sections.

NXOpen::Axis *	AlignAxis ()
	Returns the alignment axis Created in NX5.0.0.

NXOpen::Section *	AlignCurve ()
	Returns the align curve Created in NX5.0.0.

NXOpen::GeometricUtilities::AlignmentMethodBuilder::Type	AlignType ()
	Returns the alignment type Created in NX5.0.0.

NXOpen::Direction *	AlignVector ()
	Returns the alignment vector Created in NX5.0.0.

void	ComputeDefaultPoints ()
	Calculate default alignment points on existing sections.

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	CreateOnPathDimBuilder (NXOpen::Section *sec, const NXOpen::Point3d &pnt)
	Set the sections.

NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType	EndAlignFillerSurfaceOption ()
	Returns the end align filler surface option Created in NX8.0.0.

std::vector < NXOpen::GeometricUtilities::OnPathDimensionBuilder * >	GetAllPoints (int *numSection)
	Get all of the alignment points, returns as a single dimension array.

NXOpen::GeometricUtilities::OnPathDimensionBuilder *	GetPoint (int sectionIndex, int pointIndex)
	Gets an alignment point for a section.

int	NumberOfPointsPerSection ()
	Returns the number of alignment points in each section.

int	NumberOfSections ()
	Returns the number of section in the alignment point block Created in NX5.0.1.

void	RemoveAllPoints ()
	Remove all alignment points.

void	RemovePoint (NXOpen::GeometricUtilities::OnPathDimensionBuilder *alignPoint)
	Remove given point, also remove corresponding points on other sections Created in NX5.0.0.

void	RemoveSection (NXOpen::Section *sec)
	Find and delete the section Created in NX5.0.0.

void	RemoveSectionAtIndex (int secIndex)
	Remove section at given index Created in NX5.0.0.

void	SetAlignAxis (NXOpen::Axis *alignAxis)
	Sets the alignment axis Created in NX5.0.0.

void	SetAlignPoints (const std::vector< NXOpen::GeometricUtilities::OnPathDimensionBuilder * > &alignPoints)
	Set the Alignment Points when sections have been set up.

void	SetAlignType (NXOpen::GeometricUtilities::AlignmentMethodBuilder::Type alignType)
	Sets the alignment type Created in NX5.0.0.

void	SetAlignVector (NXOpen::Direction *alignVector)
	Sets the alignment vector Created in NX5.0.0.

void	SetEndAlignFillerSurfaceOption (NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType fillerSurfaceType)
	Sets the end align filler surface option Created in NX8.0.0.

void	SetSections (const std::vector< NXOpen::Section * > &sections)
	Set the sections.

void	SetStartAlignFillerSurfaceOption (NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType fillerSurfaceType)
	Sets the start align filler surface option Created in NX8.0.0.

NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType	StartAlignFillerSurfaceOption ()
	Returns the start align filler surface option Created in NX8.0.0.

void	UnloadSections ()
	Unload sections held by the builder Created in NX5.0.0.

void	UpdateSectionAtIndex (int secIndex)
	Update section at given index Created in NX5.0.0.

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

Represents a GeometricUtilities::AlignmentMethodBuilder.

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType

Filler surface types.

Enumerator:

AlignFillerSurfaceTypeNoFiller	No end filler surface.
AlignFillerSurfaceTypeCone	Generalized conical developable surface.
AlignFillerSurfaceTypeCylinder	Generalized cylindrical developable surface.
AlignFillerSurfaceTypeTrimmed	Trimmed developable surface.

enum NXOpen::GeometricUtilities::AlignmentMethodBuilder::Type

Alignment types supported.

Enumerator:

TypeParameter	parameter
TypeArcLength	arc length
TypePoints	points
TypeDistance	distance
TypeAngle	angle
TypeSpineCurve	spine curve
TypeSplinePoints	spline points
TypeSegments	segments
TypeDevelopable	developable

Member Function Documentation

int NXOpen::GeometricUtilities::AlignmentMethodBuilder::AddPoint ( NXOpen::GeometricUtilities::OnPathDimensionBuilder * alignPoint )

Insert a given point, and create corresponding points on other sections.

The points on other sections are computed based on existing alignment points

Returns: Index of the newly added point on each section
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

alignPoint Pt to insert

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::AddSection	(	int	sectionIndex,
		NXOpen::Section *	sec
	)

Add a section at the given index among existing sections.

Computes points for other sections
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

sectionIndex	Where to insert. New section will have this index
sec	The New section

NXOpen::Axis* NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignAxis ( )

Returns the alignment axis
Created in NX5.0.0.

License requirements : None

NXOpen::Section* NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignCurve ( )

Returns the align curve
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::AlignmentMethodBuilder::Type NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignType ( )

Returns the alignment type
Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignVector ( )

Returns the alignment vector
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::ComputeDefaultPoints ( )

Calculate default alignment points on existing sections.

Pre-existing alignment points destroyed
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::GeometricUtilities::AlignmentMethodBuilder::CreateOnPathDimBuilder	(	NXOpen::Section *	sec,
		const NXOpen::Point3d &	pnt
	)

Set the sections.

Does not compute default alignment

Returns: The generated onPathDim
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

sec	The section on which to create the builder
pnt	The point on the section

NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType NXOpen::GeometricUtilities::AlignmentMethodBuilder::EndAlignFillerSurfaceOption ( )

Returns the end align filler surface option
Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::GeometricUtilities::OnPathDimensionBuilder *> NXOpen::GeometricUtilities::AlignmentMethodBuilder::GetAllPoints ( int * numSection )

Get all of the alignment points, returns as a single dimension array.

Returns: Gets all the points, numPoints is total number of points, not points per section
Created in NX5.0.0.

License requirements : None

Parameters

numSection Number of sections returned

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::GeometricUtilities::AlignmentMethodBuilder::GetPoint	(	int	sectionIndex,
		int	pointIndex
	)

Gets an alignment point for a section.

Returns: Created in NX5.0.1.

License requirements : None

Parameters

sectionIndex	Section on which to query the alignment point
pointIndex	Alignment point index

int NXOpen::GeometricUtilities::AlignmentMethodBuilder::NumberOfPointsPerSection ( )

Returns the number of alignment points in each section.

All the sections always have same number of alignment points
Created in NX5.0.1.

License requirements : None

int NXOpen::GeometricUtilities::AlignmentMethodBuilder::NumberOfSections ( )

Returns the number of section in the alignment point block
Created in NX5.0.1.

License requirements : None

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::RemoveAllPoints ( )

Remove all alignment points.

Keeps the sections
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::RemovePoint ( NXOpen::GeometricUtilities::OnPathDimensionBuilder * alignPoint )

Remove given point, also remove corresponding points on other sections
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

alignPoint Pt do delete

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::RemoveSection ( NXOpen::Section * sec )

Find and delete the section
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

sec	Existing section within the Alignment

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::RemoveSectionAtIndex ( int secIndex )

Remove section at given index
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

secIndex The index of the section to remove

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetAlignAxis ( NXOpen::Axis * alignAxis )

Sets the alignment axis
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

alignAxis alignaxis

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetAlignPoints ( const std::vector< NXOpen::GeometricUtilities::OnPathDimensionBuilder * > & alignPoints )

Set the Alignment Points when sections have been set up.

       The incoming points are organized section by section.  The points
       parent section match the pre-existing sections held by this object

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

alignPoints Sets the points on the section, numPoints is total number of points for all sections

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetAlignType ( NXOpen::GeometricUtilities::AlignmentMethodBuilder::Type alignType )

Sets the alignment type
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

alignType aligntype

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetAlignVector ( NXOpen::Direction * alignVector )

Sets the alignment vector
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

alignVector alignvector

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetEndAlignFillerSurfaceOption ( NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType fillerSurfaceType )

Sets the end align filler surface option
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters

fillerSurfaceType fillersurfacetype

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetSections ( const std::vector< NXOpen::Section * > & sections )

Set the sections.

Does not compute default alignment
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

sections Array of sections

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::SetStartAlignFillerSurfaceOption ( NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType fillerSurfaceType )

Sets the start align filler surface option
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters

fillerSurfaceType fillersurfacetype

NXOpen::GeometricUtilities::AlignmentMethodBuilder::AlignFillerSurfaceType NXOpen::GeometricUtilities::AlignmentMethodBuilder::StartAlignFillerSurfaceOption ( )

Returns the start align filler surface option
Created in NX8.0.0.

License requirements : None

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::UnloadSections ( )

Unload sections held by the builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::AlignmentMethodBuilder::UpdateSectionAtIndex ( int secIndex )

Update section at given index
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

secIndex The index of the section to remove

virtual bool NXOpen::GeometricUtilities::AlignmentMethodBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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

GeometricUtilities_AlignmentMethodBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation