Represents a FeatureGeneralPropertiesBuilder to be used for modifying the names of features and general objects. More...

Inheritance diagram for NXOpen::FeatureGeneralPropertiesBuilder:

Public Member Functions
bool	ApplyToWorkPart ()
	Returns the option to apply the name change to the work part.

void	DeleteFeatureName ()
	Delete the name of the feature.

void	DeleteGeneralName ()
	Delete the name of the general object.

NXString	FeatureName ()
	Returns the feature name.

NXOpen::NXObject *	FeatureObject ()
	Returns the feature.

NXString	GeneralName ()
	Returns the general name.

NXOpen::NXObject *	GeneralObject ()
	Returns the general object.

NXOpen::Point3d	GetNameLocation ()
	Gets the name location.

bool	NameLocationSpecified ()
	Returns the name location specified.

NXOpen::SelectNXObjectList *	SelectedObjects ()
	Returns the selected object(s) list.

void	SetApplyToWorkPart (bool applyToWorkPart)
	Sets the option to apply the name change to the work part.

void	SetFeatureName (const NXString &featureName)
	Sets the feature name.

void	SetFeatureName (const char *featureName)
	Sets the feature name.

void	SetFeatureObject (NXOpen::NXObject *featureObject)
	Sets the feature.

void	SetGeneralName (const NXString &generalName)
	Sets the general name.

void	SetGeneralName (const char *generalName)
	Sets the general name.

void	SetGeneralObject (NXOpen::NXObject *generalObject)
	Sets the general object.

void	SetNameLocation (const NXOpen::Point3d &nameLocation)
	Sets the name location.

void	SetNameLocationSpecified (bool nameLocationSpecified)
	Sets the name location specified.

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 FeatureGeneralPropertiesBuilder to be used for modifying the names of features and general objects.

<br> To create a new instance of this class, use @link PropertiesManager::CreateFeatureGeneralPropertiesBuilder  PropertiesManager::CreateFeatureGeneralPropertiesBuilder @endlink  <br>

Created in NX8.0.0.

Member Function Documentation

bool NXOpen::FeatureGeneralPropertiesBuilder::ApplyToWorkPart ( )

Returns the option to apply the name change to the work part.

Created in NX8.0.0.

License requirements : None

void NXOpen::FeatureGeneralPropertiesBuilder::DeleteFeatureName ( )

Delete the name of the feature.

Created in NX8.0.0.

License requirements : None

void NXOpen::FeatureGeneralPropertiesBuilder::DeleteGeneralName ( )

Delete the name of the general object.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::FeatureGeneralPropertiesBuilder::FeatureName ( )

Returns the feature name.

This is the new name of the feature.
Created in NX8.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::FeatureGeneralPropertiesBuilder::FeatureObject ( )

Returns the feature.

This is the feature object to be modified.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::FeatureGeneralPropertiesBuilder::GeneralName ( )

Returns the general name.

This is the new name of the general object.
Created in NX8.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::FeatureGeneralPropertiesBuilder::GeneralObject ( )

Returns the general object.

This is the general object to be modified.
Created in NX8.0.0.

License requirements : None

NXOpen::Point3d NXOpen::FeatureGeneralPropertiesBuilder::GetNameLocation ( )

Gets the name location.

Returns: Created in NX8.0.0.

License requirements : None

bool NXOpen::FeatureGeneralPropertiesBuilder::NameLocationSpecified ( )

Returns the name location specified.

This states whether the name location will be changed.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::FeatureGeneralPropertiesBuilder::SelectedObjects ( )

Returns the selected object(s) list.

This list should only contain one object
Created in NX8.0.0.

License requirements : None

void NXOpen::FeatureGeneralPropertiesBuilder::SetApplyToWorkPart ( bool applyToWorkPart )

Sets the option to apply the name change to the work part.

Created in NX8.0.0.

License requirements : None

Parameters

applyToWorkPart applytoworkpart

void NXOpen::FeatureGeneralPropertiesBuilder::SetFeatureName ( const NXString & featureName )

Sets the feature name.

This is the new name of the feature.
Created in NX8.0.0.

License requirements : None

Parameters

featureName featurename

void NXOpen::FeatureGeneralPropertiesBuilder::SetFeatureName ( const char * featureName )

Sets the feature name.

This is the new name of the feature.
Created in NX8.0.0.

License requirements : None

Parameters

featureName featurename

void NXOpen::FeatureGeneralPropertiesBuilder::SetFeatureObject ( NXOpen::NXObject * featureObject )

Sets the feature.

This is the feature object to be modified.
Created in NX8.0.0.

License requirements : None

Parameters

featureObject featureobject

void NXOpen::FeatureGeneralPropertiesBuilder::SetGeneralName ( const NXString & generalName )

Sets the general name.

This is the new name of the general object.
Created in NX8.0.0.

License requirements : None

Parameters

generalName generalname

void NXOpen::FeatureGeneralPropertiesBuilder::SetGeneralName ( const char * generalName )

Sets the general name.

This is the new name of the general object.
Created in NX8.0.0.

License requirements : None

Parameters

generalName generalname

void NXOpen::FeatureGeneralPropertiesBuilder::SetGeneralObject ( NXOpen::NXObject * generalObject )

Sets the general object.

This is the general object to be modified.
Created in NX8.0.0.

License requirements : None

Parameters

generalObject generalobject

void NXOpen::FeatureGeneralPropertiesBuilder::SetNameLocation ( const NXOpen::Point3d & nameLocation )

Sets the name location.

If name location specified is true, this value will be used to change the name location of the general object.
Created in NX8.0.0.

License requirements : None

Parameters

nameLocation the name location

void NXOpen::FeatureGeneralPropertiesBuilder::SetNameLocationSpecified ( bool nameLocationSpecified )

Sets the name location specified.

This states whether the name location will be changed.
Created in NX8.0.0.

License requirements : None

Parameters

nameLocationSpecified namelocationspecified

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

FeatureGeneralPropertiesBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation