NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::AlignmentMethodBuilder Class Reference

Represents a GeometricUtilities::AlignmentMethodBuilder. More...

Inheritance diagram for NXOpen::GeometricUtilities::AlignmentMethodBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  Type {
  TypeParameter, TypeArcLength, TypePoints, TypeDistance,
  TypeAngle, TypeSpineCurve, TypeSplinePoints, TypeSegments
}
 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::AxisAlignAxis ()
 Returns the alignment axis
Created in NX5.0.0.
NXOpen::SectionAlignCurve ()
 Returns the align curve
Created in NX5.0.0.
NXOpen::GeometricUtilities::AlignmentMethodBuilder::Type AlignType ()
 Returns the alignment type
Created in NX5.0.0.
NXOpen::DirectionAlignVector ()
 Returns the alignment vector
Created in NX5.0.0.
void ComputeDefaultPoints ()
 Calculate default alignment points on existing sections.
NXOpen::GeometricUtilities::OnPathDimensionBuilderCreateOnPathDimBuilder (NXOpen::Section *sec, const NXOpen::Point3d &pnt)
 Set the sections.
std::vector
< NXOpen::GeometricUtilities::OnPathDimensionBuilder * > 
GetAllPoints (int *numSection)
 Get all of the alignment points, returns as a single dimension array.
NXOpen::GeometricUtilities::OnPathDimensionBuilderGetPoint (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 SetSections (const std::vector< NXOpen::Section * > &sections)
 Set the sections.
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.

Detailed Description

Represents a GeometricUtilities::AlignmentMethodBuilder.


Created in NX5.0.0.


Member Enumeration Documentation

Alignment types supported.

Enumerator:
TypeParameter 

parameter

TypeArcLength 

arc length

TypePoints 

points

TypeDistance 

distance

TypeAngle 

angle

TypeSpineCurve 

spine curve

TypeSplinePoints 

spline points

TypeSegments 

segments


Member Function Documentation

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:
alignPointPt to insert

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:
sectionIndexWhere to insert. New section will have this index
secThe New section

Returns the alignment axis
Created in NX5.0.0.



License requirements : None

Returns the align curve
Created in NX5.0.0.



License requirements : None

Returns the alignment type
Created in NX5.0.0.



License requirements : None

Returns the alignment vector
Created in NX5.0.0.



License requirements : None

Calculate default alignment points on existing sections.

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

License requirements : solid_modeling ("SOLIDS MODELING")

Set the sections.

Does not compute default alignment

Returns:
The generated onPathDim
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
Parameters:
secThe section on which to create the builder
pntThe point on the section

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:
numSectionNumber of sections returned

Gets an alignment point for a section.

Returns:

Created in NX5.0.1.

License requirements : None
Parameters:
sectionIndexSection on which to query the alignment point
pointIndexAlignment point index

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

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



License requirements : None

Remove all alignment points.

Keeps the sections
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
alignPointPt do delete

Find and delete the section
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
secExisting section within the Alignment

Remove section at given index
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
secIndexThe index of the section to remove

Sets the alignment axis
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
alignAxisalignaxis

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:
alignPointsSets the points on the section, numPoints is total number of points for all sections

Sets the alignment type
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
alignTypealigntype

Sets the alignment vector
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
alignVectoralignvector

Set the sections.

Does not compute default alignment
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
sectionsArray of sections

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



License requirements : solid_modeling ("SOLIDS MODELING")

Update section at given index
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
secIndexThe index of the section to remove

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.