NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::SubdivideSegmentBuilder Class Reference

Represents a Routing::SubdivideSegmentBuilder . More...

Inheritance diagram for NXOpen::Routing::SubdivideSegmentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  EqualSegmentsMethod { EqualSegmentsMethodEqualArcLength, EqualSegmentsMethodEqualParameter }
 Options for subdivision with Equal Segments spacing method. More...
enum  Types { TypesAtPoint, TypesEqualSegments, TypesArcLengthSegments }
 Spacing method to use for subdivision. More...

Public Member Functions

NXOpen::Routing::SubdivideSegmentBuilder::EqualSegmentsMethod EqualSegmentsOption ()
 Returns the equal segments option as Routing::SubdivideSegmentBuilder::EqualSegmentsMethod
Created in NX6.0.0.
void GetSplineSettings (bool *createTangency, bool *createPoints)
 Gets the current subdivide spline settings.
void GetSplineSettings (bool *createTangency, bool *createPoints, bool *addFixConstraint)
 Gets the current subdivide spline settings.
bool ReverseSubdividePoint ()
 Returns the direction of the start of segment to subdivide.
NXOpen::Routing::SelectISegmentSegment ()
 Returns the segment to subdivide
Created in NX6.0.0.
void SetEqualSegmentsOption (NXOpen::Routing::SubdivideSegmentBuilder::EqualSegmentsMethod equalSegmentsOption)
 Sets the equal segments option as Routing::SubdivideSegmentBuilder::EqualSegmentsMethod
Created in NX6.0.0.
void SetReverseSubdividePoint (bool reverseSubdividePoint)
 Sets the direction of the start of segment to subdivide.
void SetSplineSettings (bool createTangency, bool addPoints)
 Sets options for subdividing splines.
void SetSplineSettings (bool createTangency, bool addPoints, bool addFixConstraint)
 Sets options for subdividing splines.
void SetSubdivideNumSegments (int subdivideNumSegments)
 Sets the number of subdivisions to do on the given segment, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.
void SetType (NXOpen::Routing::SubdivideSegmentBuilder::Types type)
 Sets the spacing method as Routing::SubdivideSegmentBuilder::Types
Created in NX6.0.0.
NXOpen::GeometricUtilities::OnPathDimensionBuilderSubdivideArcLength ()
 Returns the arc length of each resulting segment from subdivision, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.
NXOpen::GeometricUtilities::OnPathDimensionBuilderSubdivideEndPercentage ()
 Returns the end location of subdivision on the segment as percentage, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.
int SubdivideNumSegments ()
 Returns the number of subdivisions to do on the given segment, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.
NXOpen::GeometricUtilities::OnPathDimensionBuilderSubdividePoint ()
 Returns the location of the subdivision point on segment as arclength or arclength or point, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesAtPoint.
NXOpen::GeometricUtilities::OnPathDimensionBuilderSubdivideStartPercentage ()
 Returns the start location of subdivision on the segment as percentage, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.
NXOpen::Routing::SubdivideSegmentBuilder::Types Type ()
 Returns the spacing method as Routing::SubdivideSegmentBuilder::Types
Created in NX6.0.0.

Detailed Description

Represents a Routing::SubdivideSegmentBuilder .

This is used to subidivide a given segment into two or more segments based on one of the three spacing methods.
To create a new instance of this class, use Routing::RouteManager::CreateSubdivideSegmentBuilder
Default values.

Property Value

EqualSegmentsOption

EqualArcLength

SubdivideNumSegments

2


Created in NX6.0.0.


Member Enumeration Documentation

Options for subdivision with Equal Segments spacing method.

Enumerator:
EqualSegmentsMethodEqualArcLength 

Equal Arc Length.

EqualSegmentsMethodEqualParameter 

Equal Parameter.

Spacing method to use for subdivision.

Enumerator:
TypesAtPoint 

At Point.

TypesEqualSegments 

Equal Segments.

TypesArcLengthSegments 

Arc Length Segments.


Member Function Documentation

Returns the equal segments option as Routing::SubdivideSegmentBuilder::EqualSegmentsMethod
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

void NXOpen::Routing::SubdivideSegmentBuilder::GetSplineSettings ( bool *  createTangency,
bool *  createPoints 
)

Gets the current subdivide spline settings.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
createTangencyCreates tangency at the point where the spline is subdivided by adding parallel extensions.
createPointsAdd points to the new segments to maintain shape after subdivision.
void NXOpen::Routing::SubdivideSegmentBuilder::GetSplineSettings ( bool *  createTangency,
bool *  createPoints,
bool *  addFixConstraint 
)

Gets the current subdivide spline settings.


Created in NX7.5.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
createTangencyCreates tangency at the point where the spline is subdivided by adding parallel extensions.
createPointsAdd points to the new segments to maintain shape after subdivision.
addFixConstraintAdds a fix constraint at newly created subdivision locations

Returns the direction of the start of segment to subdivide.

The distance of the subdivision point on the segment is measured from this end.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the segment to subdivide
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the equal segments option as Routing::SubdivideSegmentBuilder::EqualSegmentsMethod
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
equalSegmentsOptionequalsegmentsoption

Sets the direction of the start of segment to subdivide.

The distance of the subdivision point on the segment is measured from this end.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
reverseSubdividePointreversesubdividepoint
void NXOpen::Routing::SubdivideSegmentBuilder::SetSplineSettings ( bool  createTangency,
bool  addPoints 
)

Sets options for subdividing splines.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
createTangencyCreates tangency at the point where the spline is subdivided by adding parallel extensions.
addPointsAdd points to the new segments to maintain shape after subdivision.
void NXOpen::Routing::SubdivideSegmentBuilder::SetSplineSettings ( bool  createTangency,
bool  addPoints,
bool  addFixConstraint 
)

Sets options for subdividing splines.


Created in NX7.5.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
createTangencyCreates tangency at the point where the spline is subdivided by adding parallel extensions.
addPointsAdd points to the new segments to maintain shape after subdivision.
addFixConstraintAdds a fix constraint at newly created subdivision locations

Sets the number of subdivisions to do on the given segment, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
subdivideNumSegmentssubdividenumsegments

Sets the spacing method as Routing::SubdivideSegmentBuilder::Types
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
typetype

Returns the arc length of each resulting segment from subdivision, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the end location of subdivision on the segment as percentage, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the number of subdivisions to do on the given segment, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the location of the subdivision point on segment as arclength or arclength or point, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesAtPoint.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the start location of subdivision on the segment as percentage, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesEqualSegments or Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the spacing method as Routing::SubdivideSegmentBuilder::Types
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


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