NXOpen::GeometricUtilities::ControlPoleManagerData Class Reference

This class manages the control poles for a set of surfaces or curves. More...

Inheritance diagram for NXOpen::GeometricUtilities::ControlPoleManagerData:

Public Member Functions
int	CreatePolesGroup ()
	Creates a new poles group.
void	DeletePolesGroup (int groupIndex)
	Deletes a group of poles Created in NX6.0.1.
void	DeselectPoles (int groupIndex, const std::vector< int > &polesIndex, const std::vector< NXOpen::Point * > &poles)
	Removes selected pole Created in NX6.0.0.
bool	GetIsUPeriodic (int groupIndex)
	Queries periodicity in U direction of a group of poles.
bool	GetIsVPeriodic (int groupIndex)
	Queries periodicity in V direction of a group of poles.
void	GetPoles (int groupIndex, std::vector< int > &polesIndex, std::vector< NXOpen::Point * > &poles)
	Gets poles of an entity Created in NX6.0.0.
void	GetSelectedPoles (int groupIndex, std::vector< int > &polesIndex, std::vector< NXOpen::Point * > &poles)
	Gets selected poles Created in NX6.0.0.
int	GetUDimension (int groupIndex)
	Queries dimension in U direction of a group of poles.
int	GetVDimension (int groupIndex)
	Queries dimension in V direction of a group of poles.
void	SelectPoles (int groupIndex, const std::vector< int > &polesIndex, const std::vector< NXOpen::Point * > &poles)
	Adds new selected pole Created in NX6.0.0.
void	SetIsUPeriodic (int groupIndex, bool uPeriodicity)
	Sets periodicity in U direction of a group of poles Created in NX6.0.1.
void	SetIsVPeriodic (int groupIndex, bool vPeriodicity)
	Sets periodicity in V direction of a group of poles Created in NX6.0.1.
void	SetPoleGroupEntity (int groupIndex, NXOpen::Face *face)
	Sets face to control poles group Created in NX7.0.0.
void	SetPoleGroupEntity (int groupIndex, NXOpen::Curve *curve)
	Sets curve to control poles group Created in NX7.0.0.
void	SetPoles (int groupIndex, const std::vector< int > &polesIndex, const std::vector< NXOpen::Point * > &poles)
	Sets new group poles Created in NX6.0.0.
void	SetUDimension (int groupIndex, int uDimension)
	Sets dimension in U direction of a group of poles Created in NX6.0.1.
void	SetVDimension (int groupIndex, int vDimension)
	Sets dimension in V direction of a group of poles Created in NX6.0.1.
void	UpdatePolePositions (int groupIndex, const std::vector< int > &poleIndex, const std::vector< NXOpen::Point3d > &newPosition)
	Updates pole positions Created in NX7.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

This class manages the control poles for a set of surfaces or curves.

Created in NX6.0.0.

Member Function Documentation

int NXOpen::GeometricUtilities::ControlPoleManagerData::CreatePolesGroup

(

)

Creates a new poles group.

Returns

New group index for newly created poles group.
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

void NXOpen::GeometricUtilities::ControlPoleManagerData::DeletePolesGroup

(

int

groupIndex

)

Deletes a group of poles
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex

Group index for the group to be deleted.

void NXOpen::GeometricUtilities::ControlPoleManagerData::DeselectPoles	(	int	groupIndex,
		const std::vector< int > &	polesIndex,
		const std::vector< NXOpen::Point * > &	poles
	)

Removes selected pole
Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	Entity group index. Control Pole Manager needs to handle poles from different surfaces or curves. Therefore, poles need to be grouped. Poles associated with the same entity are placed into a group. When setting or getting poles from the Pole Manager, the caller needs to provide a group index to identify poles with the proper entity group.
polesIndex	Poles index
poles	Poles

bool NXOpen::GeometricUtilities::ControlPoleManagerData::GetIsUPeriodic

(

int

groupIndex

)

Queries periodicity in U direction of a group of poles.

Returns

U Periodicity
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex

poles group index

bool NXOpen::GeometricUtilities::ControlPoleManagerData::GetIsVPeriodic

(

int

groupIndex

)

Queries periodicity in V direction of a group of poles.

Returns

V Periodicity
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex

poles group index

void NXOpen::GeometricUtilities::ControlPoleManagerData::GetPoles	(	int	groupIndex,
		std::vector< int > &	polesIndex,
		std::vector< NXOpen::Point * > &	poles
	)

Gets poles of an entity
Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	Entity group index. Control Pole Manager needs to handle poles from different surfaces or curves. Therefore, poles need to be grouped. Poles associated with the same entity are placed into a group. When setting or getting poles from the Pole Manager, the caller needs to provide a group index to identify poles with the proper entity group.
polesIndex	Poles index
poles	Poles

void NXOpen::GeometricUtilities::ControlPoleManagerData::GetSelectedPoles	(	int	groupIndex,
		std::vector< int > &	polesIndex,
		std::vector< NXOpen::Point * > &	poles
	)

Gets selected poles
Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	Entity group index. Control Pole Manager needs to handle poles from different surfaces or curves. Therefore, poles need to be grouped. Poles associated with the same entity are placed into a group. When setting or getting poles from the Pole Manager, the caller needs to provide a group index to identify poles with the proper entity group.
polesIndex	Poles index
poles	Poles

int NXOpen::GeometricUtilities::ControlPoleManagerData::GetUDimension

(

int

groupIndex

)

Queries dimension in U direction of a group of poles.

Returns

U Dimension
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex

poles group index

int NXOpen::GeometricUtilities::ControlPoleManagerData::GetVDimension

(

int

groupIndex

)

Queries dimension in V direction of a group of poles.

Returns

V Dimension
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex

poles group index

void NXOpen::GeometricUtilities::ControlPoleManagerData::SelectPoles	(	int	groupIndex,
		const std::vector< int > &	polesIndex,
		const std::vector< NXOpen::Point * > &	poles
	)

Adds new selected pole
Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	Entity group index. Control Pole Manager needs to handle poles from different surfaces or curves. Therefore, poles need to be grouped. Poles associated with the same entity are placed into a group. When setting or getting poles from the Pole Manager, the caller needs to provide a group index to identify poles with the proper entity group.
polesIndex	Poles index
poles	Poles

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetIsUPeriodic	(	int	groupIndex,
		bool	uPeriodicity
	)

Sets periodicity in U direction of a group of poles
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	poles group index
uPeriodicity	U Periodicity

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetIsVPeriodic	(	int	groupIndex,
		bool	vPeriodicity
	)

Sets periodicity in V direction of a group of poles
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	poles group index
vPeriodicity	V Periodicity

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetPoleGroupEntity	(	int	groupIndex,
		NXOpen::Face *	face
	)

Sets face to control poles group
Created in NX7.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	pole group index
face	face

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetPoleGroupEntity	(	int	groupIndex,
		NXOpen::Curve *	curve
	)

Sets curve to control poles group
Created in NX7.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	pole group index
curve	curve

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetPoles	(	int	groupIndex,
		const std::vector< int > &	polesIndex,
		const std::vector< NXOpen::Point * > &	poles
	)

Sets new group poles
Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	Entity group index. Control Pole Manager needs to handle poles from different surfaces or curves. Therefore, poles need to be grouped. Poles associated with the same entity are placed into a group. When setting or getting poles from the Pole Manager, the caller needs to provide a group index to identify poles with the proper entity group.
polesIndex	Poles index
poles	Poles

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetUDimension	(	int	groupIndex,
		int	uDimension
	)

Sets dimension in U direction of a group of poles
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	poles group index
uDimension	U Dimension

void NXOpen::GeometricUtilities::ControlPoleManagerData::SetVDimension	(	int	groupIndex,
		int	vDimension
	)

Sets dimension in V direction of a group of poles
Created in NX6.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	poles group index
vDimension	V Dimension

void NXOpen::GeometricUtilities::ControlPoleManagerData::UpdatePolePositions	(	int	groupIndex,
		const std::vector< int > &	poleIndex,
		const std::vector< NXOpen::Point3d > &	newPosition
	)

Updates pole positions
Created in NX7.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

groupIndex	poles group index
poleIndex	pole index in the group
newPosition	Pole new position

virtual bool NXOpen::GeometricUtilities::ControlPoleManagerData::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_ControlPoleManagerData.hxx