NXOpen::Annotations::CenterlineBuilder Class Reference

Represents a Base Centerline Builder for all types of centerlines
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::CenterlineBuilder:

Public Member Functions
void	AddEndExtensions (double start, double end)
	Adds extensions only at ends Created in NX6.0.0. More...
void	AddExtension (int index, double defaultValue)
	Adds extension based on select object index Created in NX6.0.0. More...
std::vector< double >	GetAllExtensions ()
	Returns all extensions. More...
std::vector< double >	GetAllIndividualExtensions ()
	Returns individual extensions. More...
std::vector< double >	GetEndExtensions ()
	Returns end extensions only. More...
void	RemoveEndExtensions ()
	Removes extensions only at ends Created in NX6.0.0. More...
void	RemoveExtension (int index)
	Removes extension based on select object index Created in NX6.0.0. More...
void	ResetAllExtensions (double defaultValue)
	Reset all extensions by the supplied defaultValue Created in NX6.0.1. More...
void	SetAllIndividualExtensions (const std::vector< double > &extensionValues)
	Sets all individual extensions Created in NX8.0.1. More...
void	SetEndExtensions (double start, double end)
	Modifies end extensions only Created in NX6.0.0. More...
void	SetIndividualExtensions (int index, double value1, double value2)
	Modifies extensions based on select object index Created in NX6.0.0. More...

Detailed Description

Represents a Base Centerline Builder for all types of centerlines
This is an abstract class, and cannot be instantiated.

Created in NX6.0.0.

Member Function Documentation

void NXOpen::Annotations::CenterlineBuilder::AddEndExtensions	(	double	start,
		double	end
	)

Adds extensions only at ends
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

start	Default start extension value
end	Default end extension value

void NXOpen::Annotations::CenterlineBuilder::AddExtension	(	int	index,
		double	defaultValue
	)

Adds extension based on select object index
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

index	Index of the selected object
defaultValue	Default extension value

std::vector<double> NXOpen::Annotations::CenterlineBuilder::GetAllExtensions

(

)

Returns all extensions.

If the builder is a NXOpen::Annotations::BoltCircleCenterlineBuilder or NXOpen::Annotations::CircularCenterlineBuilder and NXOpen::Annotations::CircleCenterlineSettingsBuilder::IndividualDistance is false, this will method will return no extensions.

Returns

Extension values as output
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

std::vector<double> NXOpen::Annotations::CenterlineBuilder::GetAllIndividualExtensions

(

)

Returns individual extensions.

This method is applicable only for NXOpen::Annotations::CenterMark and NXOpen::Annotations::CircleCenterline .

If the builder is a NXOpen::Annotations::BoltCircleCenterlineBuilder or NXOpen::Annotations::CircularCenterlineBuilder and NXOpen::Annotations::CircleCenterlineSettingsBuilder::IndividualDistance is false, this will method will return no extensions.

Returns

Extension values as output
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

std::vector<double> NXOpen::Annotations::CenterlineBuilder::GetEndExtensions

(

)

Returns end extensions only.

The first and the last extension of the centerline.

If the builder is a NXOpen::Annotations::BoltCircleCenterlineBuilder or NXOpen::Annotations::CircularCenterlineBuilder and NXOpen::Annotations::CircleCenterlineSettingsBuilder::IndividualDistance is false, this will method will return no extensions.

Returns

Extension values as output
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::CenterlineBuilder::RemoveEndExtensions

(

)

Removes extensions only at ends
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::CenterlineBuilder::RemoveExtension

(

int

index

)

Removes extension based on select object index
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

index

Index of the selected object

void NXOpen::Annotations::CenterlineBuilder::ResetAllExtensions

(

double

defaultValue

)

Reset all extensions by the supplied defaultValue
Created in NX6.0.1.

License requirements : drafting ("DRAFTING")

Parameters

defaultValue

New extension value

void NXOpen::Annotations::CenterlineBuilder::SetAllIndividualExtensions

(

const std::vector< double > &

extensionValues

)

Sets all individual extensions
Created in NX8.0.1.

License requirements : drafting ("DRAFTING")

Parameters

extensionValues

Extension values as input

void NXOpen::Annotations::CenterlineBuilder::SetEndExtensions	(	double	start,
		double	end
	)

Modifies end extensions only
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

start	New extension value at one end
end	New extension value at one end

void NXOpen::Annotations::CenterlineBuilder::SetIndividualExtensions	(	int	index,
		double	value1,
		double	value2
	)

Modifies extensions based on select object index
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

index	Index of the selected object
value1	New extension value at one end
value2	New extension value at other end

---

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

• Annotations_CenterlineBuilder.hxx