NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder Class Reference

Represents a builder to be used to add face characteristics attributes and color to specified faces. More...

Inheritance diagram for NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::NXColorCharacteristicColor ()
 Returns the characteristic color to assign to the selected face. More...
 
int CharacteristicValue ()
 Returns the characteristic value to assign to the selected face. More...
 
NXOpen::ScCollectorSelectFace ()
 Returns the face to assign the specific characteristics. More...
 
void SetCharacteristicColor (NXOpen::NXColor *characteristicColor)
 Sets the characteristic color to assign to the selected face. More...
 
void SetCharacteristicValue (int characteristicValue)
 Sets the characteristic value to assign to the selected face. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a builder to be used to add face characteristics attributes and color to specified faces.


To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateFaceCharacteristicsBuilder

Created in NX12.0.0.

Member Function Documentation

NXOpen::NXColor* NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder::CharacteristicColor ( )

Returns the characteristic color to assign to the selected face.


Created in NX12.0.0.

License requirements : None

int NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder::CharacteristicValue ( )

Returns the characteristic value to assign to the selected face.


Created in NX12.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder::SelectFace ( )

Returns the face to assign the specific characteristics.


Created in NX12.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder::SetCharacteristicColor ( NXOpen::NXColor characteristicColor)

Sets the characteristic color to assign to the selected face.


Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
characteristicColorcharacteristiccolor
void NXOpen::Features::ShipDesign::GeneralArrangement::FaceCharacteristicsBuilder::SetCharacteristicValue ( int  characteristicValue)

Sets the characteristic value to assign to the selected face.


Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
characteristicValuecharacteristicvalue

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