NXOpen::Routing::SubdivideSegmentBuilder Class Reference

Represents a Routing::SubdivideSegmentBuilder . More...

Inheritance diagram for NXOpen::Routing::SubdivideSegmentBuilder:

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::SelectISegment *	Segment ()
	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::OnPathDimensionBuilder *	SubdivideArcLength ()
	Returns the arc length of each resulting segment from subdivision, if Routing::SubdivideSegmentBuilder::Types is Routing::SubdivideSegmentBuilder::TypesArcLengthSegments.
NXOpen::GeometricUtilities::OnPathDimensionBuilder *	SubdivideEndPercentage ()
	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::OnPathDimensionBuilder *	SubdividePoint ()
	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::OnPathDimensionBuilder *	SubdivideStartPercentage ()
	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.
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

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

enum NXOpen::Routing::SubdivideSegmentBuilder::EqualSegmentsMethod

Options for subdivision with Equal Segments spacing method.

Enumerator:

EqualSegmentsMethodEqualArcLength	Equal Arc Length.
EqualSegmentsMethodEqualParameter	Equal Parameter.

enum NXOpen::Routing::SubdivideSegmentBuilder::Types

Spacing method to use for subdivision.

Enumerator:

TypesAtPoint	At Point.
TypesEqualSegments	Equal Segments.
TypesArcLengthSegments	Arc Length Segments.

Member Function Documentation

NXOpen::Routing::SubdivideSegmentBuilder::EqualSegmentsMethod NXOpen::Routing::SubdivideSegmentBuilder::EqualSegmentsOption

(

)

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

License requirements : routing_base ("Routing Basic")

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

Gets the current subdivide spline settings.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

createTangency	Creates tangency at the point where the spline is subdivided by adding parallel extensions.
createPoints	Add 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_base ("Routing Basic")

Parameters

createTangency	Creates tangency at the point where the spline is subdivided by adding parallel extensions.
createPoints	Add points to the new segments to maintain shape after subdivision.
addFixConstraint	Adds a fix constraint at newly created subdivision locations

bool NXOpen::Routing::SubdivideSegmentBuilder::ReverseSubdividePoint

(

)

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_base ("Routing Basic")

NXOpen::Routing::SelectISegment* NXOpen::Routing::SubdivideSegmentBuilder::Segment

(

)

Returns the segment to subdivide
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SubdivideSegmentBuilder::SetEqualSegmentsOption

(

NXOpen::Routing::SubdivideSegmentBuilder::EqualSegmentsMethod

equalSegmentsOption

)

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

License requirements : routing_base ("Routing Basic")

Parameters

equalSegmentsOption

equalsegmentsoption

void NXOpen::Routing::SubdivideSegmentBuilder::SetReverseSubdividePoint

(

bool

reverseSubdividePoint

)

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_base ("Routing Basic")

Parameters

reverseSubdividePoint

reversesubdividepoint

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

Sets options for subdividing splines.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

createTangency	Creates tangency at the point where the spline is subdivided by adding parallel extensions.
addPoints	Add 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_base ("Routing Basic")

Parameters

createTangency	Creates tangency at the point where the spline is subdivided by adding parallel extensions.
addPoints	Add points to the new segments to maintain shape after subdivision.
addFixConstraint	Adds a fix constraint at newly created subdivision locations

void NXOpen::Routing::SubdivideSegmentBuilder::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.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

subdivideNumSegments

subdividenumsegments

void NXOpen::Routing::SubdivideSegmentBuilder::SetType

(

NXOpen::Routing::SubdivideSegmentBuilder::Types

type

)

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

License requirements : routing_base ("Routing Basic")

Parameters

type

type

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::SubdivideSegmentBuilder::SubdivideArcLength

(

)

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_base ("Routing Basic")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::SubdivideSegmentBuilder::SubdivideEndPercentage

(

)

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_base ("Routing Basic")

int NXOpen::Routing::SubdivideSegmentBuilder::SubdivideNumSegments

(

)

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_base ("Routing Basic")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::SubdivideSegmentBuilder::SubdividePoint

(

)

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_base ("Routing Basic")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Routing::SubdivideSegmentBuilder::SubdivideStartPercentage

(

)

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_base ("Routing Basic")

NXOpen::Routing::SubdivideSegmentBuilder::Types NXOpen::Routing::SubdivideSegmentBuilder::Type

(

)

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

License requirements : routing_base ("Routing Basic")

---

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

• Routing_SubdivideSegmentBuilder.hxx