NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::BasePart Class Reference

Base class for an NX part. More...

Inheritance diagram for NXOpen::BasePart:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::CAE::CaePart NXOpen::Part NXOpen::CAE::BaseFemPart NXOpen::CAE::SimPart NXOpen::CAE::AssyFemPart NXOpen::CAE::FemPart

Classes

struct  HistoryEventInformation
 Contains part history event information. More...
 
struct  IncompleteStatus
 Incomplete part return data. More...
 
struct  TransientStatus
 Transient part return data. More...
 

Public Types

enum  BookmarkOption {
  BookmarkOptionAll, BookmarkOptionComponentGroupsLoadOptions, BookmarkOptionComponentGroupsOnly, BookmarkOptionAllPlusDisplay,
  BookmarkOptionComponentGroupsLoadOptionsPlusDisplay, BookmarkOptionComponentGroupsOnlyPlusDisplay, BookmarkOptionDisplayOnly, BookmarkOptionEmpty
}
 Controls the information written to a bookmark file. More...
 
enum  CloseAfterSave { CloseAfterSaveFalse, CloseAfterSaveTrue }
 Used to specify whether a part should be closed after it is saved. More...
 
enum  CloseModified { CloseModifiedUseResponses, CloseModifiedCloseModified, CloseModifiedDontCloseModified }
 Indicates how part close should handle component parts when they are modified. More...
 
enum  CloseWholeTree { CloseWholeTreeFalse, CloseWholeTreeTrue }
 Used to specify whether or not to close a part's components during a close operation. More...
 
enum  CollaborativeContentType {
  CollaborativeContentTypeWorkset, CollaborativeContentTypeSubset, CollaborativeContentTypeShapeDesignElement, CollaborativeContentTypeOverridePart,
  CollaborativeContentTypeNotAssigned
}
 Represents the collaborative content type corresponding to this part. More...
 
enum  PartPreview { PartPreviewNone, PartPreviewOnSave, PartPreviewOnDemand }
 Specifies the preview mode of the part file. More...
 
enum  SaveComponents { SaveComponentsFalse, SaveComponentsTrue }
 Used to specify whether a part's components should be saved (if modified) when the part is saved. More...
 
enum  Units { UnitsInches, UnitsMillimeters }
 The units of the part file. More...
 
- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

NXOpen::GeometricAnalysis::AnalysisManagerAnalysisManager ()
 Returns the GeometricAnalysisManager for part
Created in NX5.0.0. More...
 
NXOpen::ArcCollectionArcs ()
 Returns the ArcCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Assemblies::ProductOutlineManagerAssemblies ()
 Returns the NXOpen::Assemblies::ProductOutlineManager belonging to this session
Created in NX6.0.0. More...
 
NXOpen::Assemblies::AssemblyManagerAssemblyManager ()
 Returns the NXOpen::Assemblies::AssemblyManager belonging to this session
Created in NX6.0.0. More...
 
void AssignPermanentName (const NXString &newFileName)
 Saves a temporary part with the given name. More...
 
void AssignPermanentName (const char *newFileName)
 Saves a temporary part with the given name. More...
 
NXOpen::AxisCollectionAxes ()
 Returns the AxisCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Features::BaseFeatureCollectionBaseFeatures ()
 Returns the FeatureCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Display::CameraCollectionCameras ()
 Returns the Display.CameraCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::CAM::CAMFeatureCollectionCAMFeatures ()
 Returns the CAMFeatureCollection instance belonging to this part
Created in NX7.5.0. More...
 
bool CanBeDisplayPart ()
 Returns true if the part can be displayed and false if not displayed. More...
 
NXOpen::Display::CgfxAttrCollectionCgfxAttrs ()
 Returns the Display.CgfxAttrCollection instance belonging to this part
Created in NX5.0.6. More...
 
NXOpen::Display::CgfxMattexCollectionCgfxMattex ()
 Returns the Display.CgfxMattexCollection instance belonging to this part
Created in NX5.0.6. More...
 
void Close (NXOpen::BasePart::CloseWholeTree wholeTree, NXOpen::BasePart::CloseModified closeModified, NXOpen::PartCloseResponses *responses)
 Closes an open part. More...
 
NXOpen::ColorManagerColors ()
 Manages the standard NX colors
Created in NX3.0.0. More...
 
void CompleteStructure ()
 Make additions necessary to complete the incomplete assembly structure of the input part
Created in NX4.0.0. More...
 
NXOpen::Assemblies::ComponentAssemblyComponentAssembly ()
 Returns the component assembly. More...
 
NXOpen::CoordinateSystemCollectionCoordinateSystems ()
 Returns the CoordinateSystemCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Display::DynamicSectionBuilderCreateDynamicSectionBuilder (bool loadFromView)
 Creates a NXOpen::Display::DynamicSectionBuilder The base part must be a displayable part, otherwise an exception will be thrown. More...
 
NXOpen::EffectivityConditionBuilderCreateEffectivityConditionBuilder (NXOpen::CollaborativeDesign *cd, const NXString &effectivityFormula)
 Creates a NXOpen::EffectivityConditionBuilder. More...
 
NXOpen::EffectivityConditionBuilderCreateEffectivityConditionBuilder (NXOpen::CollaborativeDesign *cd, const char *effectivityFormula)
 Creates a NXOpen::EffectivityConditionBuilder. More...
 
NXOpen::EffectivityConditionBuilderCreateEffectivityConditionBuilder (NXOpen::CollaborativeDesign *cd, const NXString &validationBasisFormula, const NXString &effectivityFormula)
 Creates a NXOpen::EffectivityConditionBuilder with initializing validation basis formula. More...
 
NXOpen::EffectivityConditionBuilderCreateEffectivityConditionBuilder (NXOpen::CollaborativeDesign *cd, const char *validationBasisFormula, const char *effectivityFormula)
 Creates a NXOpen::EffectivityConditionBuilder with initializing validation basis formula. More...
 
NXOpen::Display::FacetSettingsBuilderCreateFacetSettingsBuilder ()
 Creates a builder for the Facet Settings dialog. More...
 
NXOpen::GroupBuilderCreateGatewayGroupBuilder (NXOpen::Group *group)
 Creates a Groups builder. More...
 
NXOpen::Display::PerspectiveOptionsBuilderCreatePerspectiveOptionsBuilder ()
 Creates a builder for the Perspective Options dialog. More...
 
NXOpen::ReferenceSetCreateReferenceSet ()
 Creates a NXOpen::ReferenceSet object. More...
 
NXOpen::CurveCollectionCurves ()
 Returns the CurveCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::DatumCollectionDatums ()
 Returns the DatumCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Display::DecalCollectionDecals ()
 Returns the Display.DecalCollection instance belonging to this part
Created in NX3.0.0. More...
 
void DeleteReferenceSet (NXOpen::ReferenceSet *referenceSetObject)
 Deletes a NXOpen::ReferenceSet object
Created in NX6.0.0. More...
 
NXOpen::Optimization::DesignStudyCollectionDesignStudy ()
 Returns the design study instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::DirectionCollectionDirections ()
 Returns the DirectionCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Display::DynamicSectionCollectionDynamicSections ()
 Returns the Display.DynamicSectionCollection instance belonging to this part
Created in NX6.0.0. More...
 
NXOpen::EllipseCollectionEllipses ()
 Returns the EllipseCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::ExpressionGroupCollectionExpressionGroups ()
 Returns the ExpressionCollection instance belonging to this part
Created in NX10.0.0. More...
 
NXOpen::ExpressionCollectionExpressions ()
 Returns the ExpressionCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Fields::FieldManagerFieldManager ()
 Returns the field main. More...
 
NXOpen::FontCollectionFonts ()
 Returns the FontCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXString FullPath ()
 Returns the full path of the part. More...
 
NXOpen::CAE::FunctionCollectionFunctions ()
 Returns the CAE.FunctionCollection for this part
Created in NX5.0.0. More...
 
std::vector
< NXOpen::ReferenceSet * > 
GetAllReferenceSets ()
 Get all the NXOpen::ReferenceSet objects in this part. More...
 
NXOpen::BasePart::CollaborativeContentType GetCollaborativeContentType ()
 The collaborative content type of this part. More...
 
std::vector
< NXOpen::BasePart::HistoryEventInformation
GetHistoryInformation ()
 Get history of part. More...
 
NXOpen::BasePart::IncompleteStatus GetIncompleteStatus ()
 Inquire whether the provided part is flagged as being incomplete. More...
 
NXString GetMakeUniqueName ()
 Gets the Unique name on a part for the Make Unique operation. More...
 
void GetPreviewImage (int *width, int *height, std::vector< int > &pixels)
 Get the preview image This will return the graphic preview image of the part (when available). More...
 
NXOpen::BasePart::TransientStatus GetTransientStatus ()
 Inquire whether the provided part is flagged as being transient. More...
 
NXOpen::Display::GridCollectionGrids ()
 Returns the Display.GridCollection instance belonging to this part
Created in NX6.0.0. More...
 
NXOpen::HyperbolaCollectionHyperbolas ()
 Returns the HyperbolaCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Gateway::ImageCaptureManagerImageCaptureManager ()
 Returns the Gateway.ImageCaptureManager instance belonging to this part
Created in NX7.5.0. More...
 
NXOpen::Display::ImageCollectionImages ()
 Returns the Display.ImageCollection instance belonging to this part
Created in NX9.0.0. More...
 
NXOpen::Display::ImageDataCollectionImagesData ()
 Returns the Display.ImageDataCollection instance belonging to this part
Created in NX9.0.0. More...
 
NXOpen::InfiniteLineCollectionInfiniteLines ()
 Returns the InfiniteLineCollection instance belonging to this part
Created in NX7.5.0. More...
 
bool IsFullyLoaded ()
 Returns the load status of a part. More...
 
bool IsReadOnly ()
 Returns the read-only status of a part. More...
 
NXOpen::Layer::CategoryCollectionLayerCategories ()
 Returns a collection of layer categories
Created in NX3.0.0. More...
 
NXOpen::Layer::LayerManagerLayers ()
 Returns the LayerManager for this part
Created in NX3.0.0. More...
 
NXOpen::LayoutCollectionLayouts ()
 Returns the LayoutCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXString Leaf ()
 Returns the leaf name of the part. More...
 
NXOpen::LightCollectionLights ()
 Returns the LightCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::LineCollectionLines ()
 Returns the LineCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::PartLoadStatusLoadFeatureDataForSelection ()
 Ensure that feature data is loaded for a part. More...
 
NXOpen::PartLoadStatusLoadFully ()
 Ensures that this part is fully loaded. More...
 
NXOpen::PartLoadStatusLoadThisPartFully ()
 Ensures that this part is fully loaded. More...
 
NXOpen::MaterialManagerMaterialManager ()
 Returns the Material Manager belonging to this Part
Created in NX3.0.0. More...
 
NXOpen::MeasureManagerMeasureManager ()
 Returns the measure manager for this part
Created in NX3.0.0. More...
 
NXOpen::ModelingViewCollectionModelingViews ()
 Returns the ModelingViewCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::NXMatrixCollectionNXMatrices ()
 Returns the NXMatrixCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::OffsetCollectionOffsets ()
 Returns the OffsetCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Optimization::OptimizationCollectionOptimization ()
 Returns the optimization instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::ParabolaCollectionParabolas ()
 Returns the ParabolaCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::BasePart::PartPreview PartPreviewMode ()
 Returns the preview mode
Created in NX3.0.0. More...
 
NXOpen::BasePart::Units PartUnits ()
 Returns the units of the part file. More...
 
NXOpen::PDM::PdmPartPDMPart ()
 Returns the instance of the PDM.PdmPart class
Created in NX3.0.0. More...
 
NXOpen::PlaneCollectionPlanes ()
 Return a collection of Planes
Created in NX3.0.0. More...
 
NXOpen::PlotManagerPlotManager ()
 Returns the PlotManager instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::PointCollectionPoints ()
 Returns the PointCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::PolylineCollectionPolylines ()
 Returns the PolylineCollection instance belonging to this part
Created in NX10.0.0. More...
 
NXOpen::Preferences::PartPreferencesPreferences ()
 Returns the PartPreferences instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::PropertiesManagerPropertiesManager ()
 Returns the PropertiesManager instance belonging to this part
Created in NX8.0.0. More...
 
void RegenerateDisplayFacets (bool regenerateChildren)
 Regenerates display specific cached facets in the part. More...
 
void ReinstateTransience ()
 Reinstate the transient status to the formerly transient input part
Created in NX4.0.0. More...
 
void RemoveTransience ()
 Remove the transient status from the input part
Created in NX4.0.0. More...
 
NXOpen::BasePartReopen (NXOpen::BasePart::CloseWholeTree wholeTree, NXOpen::BasePart::CloseModified closeModified, NXOpen::PartCloseResponses *responses, NXOpen::PartReopenReport **reopenReport)
 Reopens a loaded part. More...
 
NXOpen::BasePartReopenAs (const NXString &fileName, NXOpen::BasePart::CloseModified closeModified, NXOpen::PartCloseResponses *responses, NXOpen::PartReopenReport **reopenReport)
 Reopens a loaded part. More...
 
NXOpen::BasePartReopenAs (const char *fileName, NXOpen::BasePart::CloseModified closeModified, NXOpen::PartCloseResponses *responses, NXOpen::PartReopenReport **reopenReport)
 Reopens a loaded part. More...
 
NXOpen::Validate::RequirementCheckCollectionRequirementChecks ()
 Returns the RequirementCheckCollection instance belonging to this part
Created in NX8.5.0. More...
 
NXOpen::Validate::RequirementCollectionRequirements ()
 Returns the RequirementCollection instance belonging to this part
Created in NX8.5.0. More...
 
void ReverseBlankAll ()
 Reverse blank all the objects in the part. More...
 
NXOpen::RuleManagerRuleManager ()
 Returns the rule manager for this part
Created in NX3.0.0. More...
 
NXOpen::PartSaveStatusSave (NXOpen::BasePart::SaveComponents saveComponentParts, NXOpen::BasePart::CloseAfterSave close)
 Saves the part whether it is modified or not. More...
 
NXOpen::PartSaveStatusSaveAs (const NXString &newFileName)
 Creates copy of target part. More...
 
NXOpen::PartSaveStatusSaveAs (const char *newFileName)
 Creates copy of target part. More...
 
void SaveBookmark (const NXString &fileName, NXOpen::BasePart::BookmarkOption option)
 Saves a bookmark file. More...
 
void SaveBookmark (const char *fileName, NXOpen::BasePart::BookmarkOption option)
 Saves a bookmark file. More...
 
bool SaveDisplayFacets ()
 Returns whether display quality facets are saved in the part file
Created in NX9.0.0. More...
 
NXOpen::PartSaveOptionsSaveOptions ()
 Returns the PartSaveOptions instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::ScalarCollectionScalars ()
 Returns the ScalarCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::ScCollectorCollectionScCollectors ()
 Returns the ScCollectorCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::SectionCollectionSections ()
 Returns the SectionCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::Display::SelPrefCollectionSelPref ()
 Returns the Display.SelPrefCollection instance belonging to this part
Created in NX3.0.0. More...
 
void SetMakeUniqueName (const NXString &newUniqueName)
 Sets the unique name on part for the Make Unique operation
Created in NX8.0.0. More...
 
void SetMakeUniqueName (const char *newUniqueName)
 Sets the unique name on part for the Make Unique operation
Created in NX8.0.0. More...
 
void SetPartPreviewMode (NXOpen::BasePart::PartPreview mode)
 Sets the preview mode
Created in NX3.0.0. More...
 
void SetSaveDisplayFacets (bool saveDisplayFacets)
 Sets whether display quality facets are saved in the part file
Created in NX9.0.0. More...
 
void SetUniqueIdentifier (const NXString &identifier)
 Sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open. More...
 
void SetUniqueIdentifier (const char *identifier)
 Sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open. More...
 
NXOpen::Display::TrueShadingCollectionSHEDObjs ()
 Returns the Display.TrueShadingCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::SplineCollectionSplines ()
 Returns the SplineCollection instance belonging to this part
Created in NX5.0.0. More...
 
NXOpen::Display::TrueStudioCollectionTrueStudioObjs ()
 Returns the Display.TrueStudioCollection instance belonging to this part
Created in NX8.0.0. More...
 
NXString UniqueIdentifier ()
 Returns the unique identifier for this part used to determine whether parts can be quietly substituted during part open. More...
 
NXOpen::UnitCollectionUnitCollection ()
 Returns a collection of Units
Created in NX3.0.0. More...
 
NXOpen::UserDefinedObjects::UserDefinedObjectManagerUserDefinedObjectManager ()
 Returns the NXOpen::UserDefinedObjects::UserDefinedObjectManager belonging to this session
Created in NX3.0.0. More...
 
NXOpen::ValidationCollectionValidations ()
 Returns the validation for this part
Created in NX3.0.0. More...
 
NXOpen::ViewCollectionViews ()
 Returns the ViewCollection instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::WCSWCS ()
 Returns the WCS instance belonging to this part
Created in NX3.0.0. More...
 
NXOpen::XformCollectionXforms ()
 Returns the XformCollection instance belonging to this part
Created in NX3.0.0. More...
 
- Public Member Functions inherited from NXOpen::NXObject
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
NXString GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
NXString GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
bool HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Base class for an NX part.


Use the NXOpen::PartCollection class to load or create a part. Use NXOpen::PartCollection::WorkComponentOption to obtain the current work part.

Created in NX4.0.0.

Member Enumeration Documentation

Controls the information written to a bookmark file.

In batch mode, the options: BasePart::BookmarkOptionAllPlusDisplay BasePart::BookmarkOptionComponentGroupsLoadOptionsPlusDisplay BasePart::BookmarkOptionComponentGroupsOnlyPlusDisplay BasePart::BookmarkOptionDisplayOnly are not supported. They will be treated as if the option specfied were: BasePart::BookmarkOptionAll BasePart::BookmarkOptionComponentGroupsLoadOptions BasePart::BookmarkOptionComponentGroupsOnly BasePart::BookmarkOptionEmpty respectively.

Enumerator
BookmarkOptionAll 

Write component groups, load options and structure.

BookmarkOptionComponentGroupsLoadOptions 

Write component groups and load options.

BookmarkOptionComponentGroupsOnly 

Write component groups only.

BookmarkOptionAllPlusDisplay 

Write component groups, load options, structure and display attributes.

BookmarkOptionComponentGroupsLoadOptionsPlusDisplay 

Write component groups, load options and display attributes.

BookmarkOptionComponentGroupsOnlyPlusDisplay 

Write component groups and display attributes.

BookmarkOptionDisplayOnly 

Write only display attributes.

BookmarkOptionEmpty 

Write nothing but header information.

Used to specify whether a part should be closed after it is saved.

Enumerator
CloseAfterSaveFalse 

false

CloseAfterSaveTrue 

true

Indicates how part close should handle component parts when they are modified.

Enumerator
CloseModifiedUseResponses 

Use the responses in NXOpen::PartCloseResponses to determine whether to close a modified part or not.

CloseModifiedCloseModified 

Close all modified parts.

CloseModifiedDontCloseModified 

Do not close any modified parts.

Used to specify whether or not to close a part's components during a close operation.

Enumerator
CloseWholeTreeFalse 

false

CloseWholeTreeTrue 

true

Represents the collaborative content type corresponding to this part.

Enumerator
CollaborativeContentTypeWorkset 

Workset.

CollaborativeContentTypeSubset 

Subset.

CollaborativeContentTypeShapeDesignElement 

Shape Design Part in a Workset.

CollaborativeContentTypeOverridePart 

Override Part.

CollaborativeContentTypeNotAssigned 

Non-collaborative content such as items.

Specifies the preview mode of the part file.

Enumerator
PartPreviewNone 

No preview image is stored for the part.

PartPreviewOnSave 

Create a preview image when the part is saved.

PartPreviewOnDemand 

Create a preview image on demand.

Used to specify whether a part's components should be saved (if modified) when the part is saved.

Enumerator
SaveComponentsFalse 

false

SaveComponentsTrue 

true

The units of the part file.

Enumerator
UnitsInches 

inches

UnitsMillimeters 

millimeters

Member Function Documentation

NXOpen::GeometricAnalysis::AnalysisManager* NXOpen::BasePart::AnalysisManager ( )

Returns the GeometricAnalysisManager for part
Created in NX5.0.0.


NXOpen::ArcCollection* NXOpen::BasePart::Arcs ( )

Returns the ArcCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Assemblies::ProductOutlineManager* NXOpen::BasePart::Assemblies ( )

Returns the NXOpen::Assemblies::ProductOutlineManager belonging to this session
Created in NX6.0.0.


NXOpen::Assemblies::AssemblyManager* NXOpen::BasePart::AssemblyManager ( )

Returns the NXOpen::Assemblies::AssemblyManager belonging to this session
Created in NX6.0.0.


void NXOpen::BasePart::AssignPermanentName ( const NXString newFileName)

Saves a temporary part with the given name.


Created in NX5.0.0.

License requirements : None

Parameters
newFileNamename of new part file to create
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::BasePart::AssignPermanentName ( const char *  newFileName)

Saves a temporary part with the given name.


Created in NX5.0.0.

License requirements : None

Parameters
newFileNamename of new part file to create
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::AxisCollection* NXOpen::BasePart::Axes ( )

Returns the AxisCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Features::BaseFeatureCollection* NXOpen::BasePart::BaseFeatures ( )

Returns the FeatureCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Display::CameraCollection* NXOpen::BasePart::Cameras ( )

Returns the Display.CameraCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::CAM::CAMFeatureCollection* NXOpen::BasePart::CAMFeatures ( )

Returns the CAMFeatureCollection instance belonging to this part
Created in NX7.5.0.


bool NXOpen::BasePart::CanBeDisplayPart ( )

Returns true if the part can be displayed and false if not displayed.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::Display::CgfxAttrCollection* NXOpen::BasePart::CgfxAttrs ( )

Returns the Display.CgfxAttrCollection instance belonging to this part
Created in NX5.0.6.


NXOpen::Display::CgfxMattexCollection* NXOpen::BasePart::CgfxMattex ( )

Returns the Display.CgfxMattexCollection instance belonging to this part
Created in NX5.0.6.


void NXOpen::BasePart::Close ( NXOpen::BasePart::CloseWholeTree  wholeTree,
NXOpen::BasePart::CloseModified  closeModified,
NXOpen::PartCloseResponses responses 
)

Closes an open part.


Created in NX4.0.0.

License requirements : None

Parameters
wholeTreeIf true, unloads all components of the part. If false, unloads only the top-level part
closeModifiedBehavior of close if component parts are modified.
responsesClass representing list of parts to close or leave open if modified. Only used if closed_modified is set to NXOpen::BasePart::CloseModifiedUseResponses . If NXOpen::BasePart::CloseModifiedUseResponses is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. See NXOpen::PartCloseResponses for how to add responses to this class.
NXOpen::ColorManager* NXOpen::BasePart::Colors ( )

Manages the standard NX colors
Created in NX3.0.0.


void NXOpen::BasePart::CompleteStructure ( )

Make additions necessary to complete the incomplete assembly structure of the input part
Created in NX4.0.0.



License requirements : None

NXOpen::Assemblies::ComponentAssembly* NXOpen::BasePart::ComponentAssembly ( )

Returns the component assembly.


Created in NX3.0.0.

License requirements : None

NXOpen::CoordinateSystemCollection* NXOpen::BasePart::CoordinateSystems ( )

Returns the CoordinateSystemCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Display::DynamicSectionBuilder* NXOpen::BasePart::CreateDynamicSectionBuilder ( bool  loadFromView)

Creates a NXOpen::Display::DynamicSectionBuilder The base part must be a displayable part, otherwise an exception will be thrown.


By default, the section builder uses the current work view. The current work view must be a modeling view, otherwise an exception will be thrown.

Returns

Deprecated:
Deprecated in NX6.0.0. Use NXOpen::BasePart::DynamicSections and NXOpen::BasePart::SetDynamicSections instead.


Created in NX5.0.0.

License requirements : None

Parameters
loadFromViewIf true, reads section information from working view. Otherwise, default section is created.
NXOpen::EffectivityConditionBuilder* NXOpen::BasePart::CreateEffectivityConditionBuilder ( NXOpen::CollaborativeDesign cd,
const NXString effectivityFormula 
)

Creates a NXOpen::EffectivityConditionBuilder.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
cdcd
effectivityFormulaeffectivityformula
NXOpen::EffectivityConditionBuilder* NXOpen::BasePart::CreateEffectivityConditionBuilder ( NXOpen::CollaborativeDesign cd,
const char *  effectivityFormula 
)

Creates a NXOpen::EffectivityConditionBuilder.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
cdcd
effectivityFormulaeffectivityformula
NXOpen::EffectivityConditionBuilder* NXOpen::BasePart::CreateEffectivityConditionBuilder ( NXOpen::CollaborativeDesign cd,
const NXString validationBasisFormula,
const NXString effectivityFormula 
)

Creates a NXOpen::EffectivityConditionBuilder with initializing validation basis formula.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
cdcd
validationBasisFormulavalidationbasisformula
effectivityFormulaeffectivityformula
NXOpen::EffectivityConditionBuilder* NXOpen::BasePart::CreateEffectivityConditionBuilder ( NXOpen::CollaborativeDesign cd,
const char *  validationBasisFormula,
const char *  effectivityFormula 
)

Creates a NXOpen::EffectivityConditionBuilder with initializing validation basis formula.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
cdcd
validationBasisFormulavalidationbasisformula
effectivityFormulaeffectivityformula
NXOpen::Display::FacetSettingsBuilder* NXOpen::BasePart::CreateFacetSettingsBuilder ( )

Creates a builder for the Facet Settings dialog.

Returns

Created in NX8.0.0.

License requirements : None
NXOpen::GroupBuilder* NXOpen::BasePart::CreateGatewayGroupBuilder ( NXOpen::Group group)

Creates a Groups builder.

Returns
GroupBuilder object
Created in NX5.0.0.

License requirements : None
Parameters
groupgroup
NXOpen::Display::PerspectiveOptionsBuilder* NXOpen::BasePart::CreatePerspectiveOptionsBuilder ( )

Creates a builder for the Perspective Options dialog.

Returns

Created in NX8.0.0.

License requirements : None
NXOpen::ReferenceSet* NXOpen::BasePart::CreateReferenceSet ( )

Creates a NXOpen::ReferenceSet object.

Returns
New reference set object
Created in NX6.0.0.

License requirements : None
NXOpen::CurveCollection* NXOpen::BasePart::Curves ( )

Returns the CurveCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::DatumCollection* NXOpen::BasePart::Datums ( )

Returns the DatumCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Display::DecalCollection* NXOpen::BasePart::Decals ( )

Returns the Display.DecalCollection instance belonging to this part
Created in NX3.0.0.


void NXOpen::BasePart::DeleteReferenceSet ( NXOpen::ReferenceSet referenceSetObject)

Deletes a NXOpen::ReferenceSet object
Created in NX6.0.0.



License requirements : None

Parameters
referenceSetObjectReference set object to be deleted
NXOpen::Optimization::DesignStudyCollection* NXOpen::BasePart::DesignStudy ( )

Returns the design study instance belonging to this part
Created in NX3.0.0.


NXOpen::DirectionCollection* NXOpen::BasePart::Directions ( )

Returns the DirectionCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Display::DynamicSectionCollection* NXOpen::BasePart::DynamicSections ( )

Returns the Display.DynamicSectionCollection instance belonging to this part
Created in NX6.0.0.


NXOpen::EllipseCollection* NXOpen::BasePart::Ellipses ( )

Returns the EllipseCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::ExpressionGroupCollection* NXOpen::BasePart::ExpressionGroups ( )

Returns the ExpressionCollection instance belonging to this part
Created in NX10.0.0.


NXOpen::ExpressionCollection* NXOpen::BasePart::Expressions ( )

Returns the ExpressionCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Fields::FieldManager* NXOpen::BasePart::FieldManager ( )

Returns the field main.


Created in NX4.0.0.

License requirements : None

NXOpen::FontCollection* NXOpen::BasePart::Fonts ( )

Returns the FontCollection instance belonging to this part
Created in NX3.0.0.


NXString NXOpen::BasePart::FullPath ( )

Returns the full path of the part.

When called in a managed environment, this will give the same value as NXOpen::BasePart::Leaf .
Created in NX3.0.0.

License requirements : None

NXOpen::CAE::FunctionCollection* NXOpen::BasePart::Functions ( )

Returns the CAE.FunctionCollection for this part
Created in NX5.0.0.


std::vector<NXOpen::ReferenceSet *> NXOpen::BasePart::GetAllReferenceSets ( )

Get all the NXOpen::ReferenceSet objects in this part.

Does not include the default reference sets Empty and Entire Part.

Returns

Created in NX7.5.0.

License requirements : None
NXOpen::BasePart::CollaborativeContentType NXOpen::BasePart::GetCollaborativeContentType ( )

The collaborative content type of this part.

It will return NXOpen::BasePart::CollaborativeContentType::NotAssigned for the part that does not represent any collaborative content.

Returns

Created in NX8.5.0.

License requirements : None
std::vector<NXOpen::BasePart::HistoryEventInformation> NXOpen::BasePart::GetHistoryInformation ( )

Get history of part.

Returns
list of history data for the part. The list is sorted in descending order on version number.
Created in NX4.0.0.

License requirements : None
NXOpen::BasePart::IncompleteStatus NXOpen::BasePart::GetIncompleteStatus ( )

Inquire whether the provided part is flagged as being incomplete.

Returns

Created in NX4.0.0.

License requirements : None
NXString NXOpen::BasePart::GetMakeUniqueName ( )

Gets the Unique name on a part for the Make Unique operation.

Returns

Created in NX8.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")
void NXOpen::BasePart::GetPreviewImage ( int *  width,
int *  height,
std::vector< int > &  pixels 
)

Get the preview image This will return the graphic preview image of the part (when available).

The call returns the image width and height and a single array of integer RGB pixels. The total number of pixels is width * height. Each 32 bit integer pixel contains 8 bit values for the red, green and blue color components and the alpha channel is not used and set to 255. The byte order corresponds to the .NET method System.Drawing.Color.FromArgb, so the order is ARGB. For Java the byte order and data corresponds to the BufferedImage type TYPE_INT_RGB. The pixels at an xy location can be found as (y*width+x) where x is from 0 to width-1, and y indexes from 0 to height-1. The RGB pixels can be loaded into an appropriate image tool such as the Java BufferedImage class for display.

Note: this will return the modeling preview image only.


Created in NX5.0.2.

License requirements : None

Parameters
widthimage width
heightimage height
pixelsArray of pixels
NXOpen::BasePart::TransientStatus NXOpen::BasePart::GetTransientStatus ( )

Inquire whether the provided part is flagged as being transient.

Returns

Created in NX4.0.0.

License requirements : None
NXOpen::Display::GridCollection* NXOpen::BasePart::Grids ( )

Returns the Display.GridCollection instance belonging to this part
Created in NX6.0.0.


NXOpen::HyperbolaCollection* NXOpen::BasePart::Hyperbolas ( )

Returns the HyperbolaCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Gateway::ImageCaptureManager* NXOpen::BasePart::ImageCaptureManager ( )

Returns the Gateway.ImageCaptureManager instance belonging to this part
Created in NX7.5.0.


NXOpen::Display::ImageCollection* NXOpen::BasePart::Images ( )

Returns the Display.ImageCollection instance belonging to this part
Created in NX9.0.0.


NXOpen::Display::ImageDataCollection* NXOpen::BasePart::ImagesData ( )

Returns the Display.ImageDataCollection instance belonging to this part
Created in NX9.0.0.


NXOpen::InfiniteLineCollection* NXOpen::BasePart::InfiniteLines ( )

Returns the InfiniteLineCollection instance belonging to this part
Created in NX7.5.0.


bool NXOpen::BasePart::IsFullyLoaded ( )

Returns the load status of a part.

Set to true if part is fully loaded and set to false if the part is partially loaded.
Created in NX3.0.0.

License requirements : None

bool NXOpen::BasePart::IsReadOnly ( )

Returns the read-only status of a part.

Set to true if part is read-only and set to false if the part is modifiable.
Created in NX5.0.2.

License requirements : None

NXOpen::Layer::CategoryCollection* NXOpen::BasePart::LayerCategories ( )

Returns a collection of layer categories
Created in NX3.0.0.


NXOpen::Layer::LayerManager* NXOpen::BasePart::Layers ( )

Returns the LayerManager for this part
Created in NX3.0.0.


NXOpen::LayoutCollection* NXOpen::BasePart::Layouts ( )

Returns the LayoutCollection instance belonging to this part
Created in NX3.0.0.


NXString NXOpen::BasePart::Leaf ( )

Returns the leaf name of the part.

When called in a managed environment, this will give the Item ID and Revision (prior to NX8.5 this method only returned the Item ID).
Created in NX3.0.0.

License requirements : None

NXOpen::LightCollection* NXOpen::BasePart::Lights ( )

Returns the LightCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::LineCollection* NXOpen::BasePart::Lines ( )

Returns the LineCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::PartLoadStatus* NXOpen::BasePart::LoadFeatureDataForSelection ( )

Ensure that feature data is loaded for a part.

Returns
If the part could not be loaded, this object contains the error information.
Created in NX6.0.1.

License requirements : None
NXOpen::PartLoadStatus* NXOpen::BasePart::LoadFully ( )

Ensures that this part is fully loaded.

If the part is already fully loaded (NXOpen::BasePart::IsFullyLoaded returns true) then this method has no effect.

Returns
If the part could not be loaded, this object contains the error information.
Created in NX5.0.0.

License requirements : None
NXOpen::PartLoadStatus* NXOpen::BasePart::LoadThisPartFully ( )

Ensures that this part is fully loaded.

If the part is already fully loaded (NXOpen::BasePart::IsFullyLoaded returns true) then this method has no effect. Does not load any components regardless of the current load option.

Returns
If the part could not be loaded, this object contains the error information.
Created in NX5.0.0.

License requirements : None
NXOpen::MaterialManager* NXOpen::BasePart::MaterialManager ( )

Returns the Material Manager belonging to this Part
Created in NX3.0.0.


NXOpen::MeasureManager* NXOpen::BasePart::MeasureManager ( )

Returns the measure manager for this part
Created in NX3.0.0.


NXOpen::ModelingViewCollection* NXOpen::BasePart::ModelingViews ( )

Returns the ModelingViewCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::NXMatrixCollection* NXOpen::BasePart::NXMatrices ( )

Returns the NXMatrixCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::OffsetCollection* NXOpen::BasePart::Offsets ( )

Returns the OffsetCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Optimization::OptimizationCollection* NXOpen::BasePart::Optimization ( )

Returns the optimization instance belonging to this part
Created in NX3.0.0.


NXOpen::ParabolaCollection* NXOpen::BasePart::Parabolas ( )

Returns the ParabolaCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::BasePart::PartPreview NXOpen::BasePart::PartPreviewMode ( )

Returns the preview mode
Created in NX3.0.0.



License requirements : None

NXOpen::BasePart::Units NXOpen::BasePart::PartUnits ( )

Returns the units of the part file.


Created in NX3.0.0.

License requirements : None

NXOpen::PDM::PdmPart* NXOpen::BasePart::PDMPart ( )

Returns the instance of the PDM.PdmPart class
Created in NX3.0.0.


NXOpen::PlaneCollection* NXOpen::BasePart::Planes ( )

Return a collection of Planes
Created in NX3.0.0.


NXOpen::PlotManager* NXOpen::BasePart::PlotManager ( )

Returns the PlotManager instance belonging to this part
Created in NX3.0.0.


NXOpen::PointCollection* NXOpen::BasePart::Points ( )

Returns the PointCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::PolylineCollection* NXOpen::BasePart::Polylines ( )

Returns the PolylineCollection instance belonging to this part
Created in NX10.0.0.


NXOpen::Preferences::PartPreferences* NXOpen::BasePart::Preferences ( )

Returns the PartPreferences instance belonging to this part
Created in NX3.0.0.


NXOpen::PropertiesManager* NXOpen::BasePart::PropertiesManager ( )

Returns the PropertiesManager instance belonging to this part
Created in NX8.0.0.


void NXOpen::BasePart::RegenerateDisplayFacets ( bool  regenerateChildren)

Regenerates display specific cached facets in the part.


Created in NX9.0.0.

License requirements : None

Parameters
regenerateChildrenShould the children of this part have their cached display facets regenerated also
void NXOpen::BasePart::ReinstateTransience ( )

Reinstate the transient status to the formerly transient input part
Created in NX4.0.0.



License requirements : None

void NXOpen::BasePart::RemoveTransience ( )

Remove the transient status from the input part
Created in NX4.0.0.



License requirements : None

NXOpen::BasePart* NXOpen::BasePart::Reopen ( NXOpen::BasePart::CloseWholeTree  wholeTree,
NXOpen::BasePart::CloseModified  closeModified,
NXOpen::PartCloseResponses responses,
NXOpen::PartReopenReport **  reopenReport 
)

Reopens a loaded part.

Returns
The reloaded part
Created in NX4.0.0.

License requirements : None
Parameters
wholeTreeIf true, unloads all components of the part. If false, unloads only the top-level part
closeModifiedBehavior of close if component parts are modified.
responsesClass representing list of parts to close or leave open if modified. Only used if closed_modified is set to NXOpen::BasePart::CloseModifiedUseResponses . If NXOpen::BasePart::CloseModifiedUseResponses is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. See NXOpen::PartCloseResponses for how to add responses to this class.
reopenReportReport containing results of reopen command
NXOpen::BasePart* NXOpen::BasePart::ReopenAs ( const NXString fileName,
NXOpen::BasePart::CloseModified  closeModified,
NXOpen::PartCloseResponses responses,
NXOpen::PartReopenReport **  reopenReport 
)

Reopens a loaded part.

Returns
The reloaded part
Created in NX4.0.0.

License requirements : None
Parameters
fileNamename of part file to open
NOTE: The full Unicode character set is not supported for this parameter.
closeModifiedBehavior of close if component parts are modified.
responsesClass representing list of parts to close or leave open if modified. Only used if closed_modified is set to NXOpen::BasePart::CloseModifiedUseResponses . If NXOpen::BasePart::CloseModifiedUseResponses is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. See NXOpen::PartCloseResponses for how to add responses to this class.
reopenReportReport containing results of reopen command
NXOpen::BasePart* NXOpen::BasePart::ReopenAs ( const char *  fileName,
NXOpen::BasePart::CloseModified  closeModified,
NXOpen::PartCloseResponses responses,
NXOpen::PartReopenReport **  reopenReport 
)

Reopens a loaded part.

Returns
The reloaded part
Created in NX4.0.0.

License requirements : None
Parameters
fileNamename of part file to open
NOTE: The full Unicode character set is not supported for this parameter.
closeModifiedBehavior of close if component parts are modified.
responsesClass representing list of parts to close or leave open if modified. Only used if closed_modified is set to NXOpen::BasePart::CloseModifiedUseResponses . If NXOpen::BasePart::CloseModifiedUseResponses is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. See NXOpen::PartCloseResponses for how to add responses to this class.
reopenReportReport containing results of reopen command
NXOpen::Validate::RequirementCheckCollection* NXOpen::BasePart::RequirementChecks ( )

Returns the RequirementCheckCollection instance belonging to this part
Created in NX8.5.0.


NXOpen::Validate::RequirementCollection* NXOpen::BasePart::Requirements ( )

Returns the RequirementCollection instance belonging to this part
Created in NX8.5.0.


void NXOpen::BasePart::ReverseBlankAll ( )

Reverse blank all the objects in the part.


Created in NX4.0.0.

License requirements : None

NXOpen::RuleManager* NXOpen::BasePart::RuleManager ( )

Returns the rule manager for this part
Created in NX3.0.0.


NXOpen::PartSaveStatus* NXOpen::BasePart::Save ( NXOpen::BasePart::SaveComponents  saveComponentParts,
NXOpen::BasePart::CloseAfterSave  close 
)

Saves the part whether it is modified or not.

Returns
Parts that could not be saved and their associated errors.
Created in NX4.0.0.

License requirements : None
Parameters
saveComponentPartsThe part's components are saved if modified if this parameter is set to NXOpen::BasePart::SaveComponentsTrue .
closeThe part is closed if this parameter is set to NXOpen::BasePart::CloseAfterSaveTrue .
NXOpen::PartSaveStatus* NXOpen::BasePart::SaveAs ( const NXString newFileName)

Creates copy of target part.

Note for using this in managed environment: This is deprecated in NX10 for "Save As of master parts" operation. This API should only be used in case of Save As Non Master parts and Save As New Item Type Operations. In managed environment, for Save As of master parts, use NXOpen::PDM::PartOperationCopyBuilder . This API will not support Save As if there are duplicate item ids in database.

Returns
Parts that could could not saved and their associated errors.
Created in NX4.0.0.

License requirements : None
Parameters
newFileNamename of new part file to create
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::PartSaveStatus* NXOpen::BasePart::SaveAs ( const char *  newFileName)

Creates copy of target part.

Note for using this in managed environment: This is deprecated in NX10 for "Save As of master parts" operation. This API should only be used in case of Save As Non Master parts and Save As New Item Type Operations. In managed environment, for Save As of master parts, use NXOpen::PDM::PartOperationCopyBuilder . This API will not support Save As if there are duplicate item ids in database.

Returns
Parts that could could not saved and their associated errors.
Created in NX4.0.0.

License requirements : None
Parameters
newFileNamename of new part file to create
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::BasePart::SaveBookmark ( const NXString fileName,
NXOpen::BasePart::BookmarkOption  option 
)

Saves a bookmark file.


Created in NX4.0.0.

License requirements : None

Parameters
fileNameName of bookmark file.
NOTE: The full Unicode character set is not supported for this parameter.
optionSee definitions of NXOpen::BasePart::BookmarkOption
void NXOpen::BasePart::SaveBookmark ( const char *  fileName,
NXOpen::BasePart::BookmarkOption  option 
)

Saves a bookmark file.


Created in NX4.0.0.

License requirements : None

Parameters
fileNameName of bookmark file.
NOTE: The full Unicode character set is not supported for this parameter.
optionSee definitions of NXOpen::BasePart::BookmarkOption
bool NXOpen::BasePart::SaveDisplayFacets ( )

Returns whether display quality facets are saved in the part file
Created in NX9.0.0.



License requirements : None

NXOpen::PartSaveOptions* NXOpen::BasePart::SaveOptions ( )

Returns the PartSaveOptions instance belonging to this part
Created in NX3.0.0.


NXOpen::ScalarCollection* NXOpen::BasePart::Scalars ( )

Returns the ScalarCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::ScCollectorCollection* NXOpen::BasePart::ScCollectors ( )

Returns the ScCollectorCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::SectionCollection* NXOpen::BasePart::Sections ( )

Returns the SectionCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::Display::SelPrefCollection* NXOpen::BasePart::SelPref ( )

Returns the Display.SelPrefCollection instance belonging to this part
Created in NX3.0.0.


void NXOpen::BasePart::SetMakeUniqueName ( const NXString newUniqueName)

Sets the unique name on part for the Make Unique operation
Created in NX8.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
newUniqueName
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::BasePart::SetMakeUniqueName ( const char *  newUniqueName)

Sets the unique name on part for the Make Unique operation
Created in NX8.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
newUniqueName
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::BasePart::SetPartPreviewMode ( NXOpen::BasePart::PartPreview  mode)

Sets the preview mode
Created in NX3.0.0.



License requirements : None

Parameters
modemode
void NXOpen::BasePart::SetSaveDisplayFacets ( bool  saveDisplayFacets)

Sets whether display quality facets are saved in the part file
Created in NX9.0.0.



License requirements : None

Parameters
saveDisplayFacetssavedisplayfacets
void NXOpen::BasePart::SetUniqueIdentifier ( const NXString identifier)

Sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open.

When set if the input value is the empty string a new unqiue uid is allocated for the part otherwise the supplied uid is used.
Created in NX6.0.5.

License requirements : None

Parameters
identifieridentifier
void NXOpen::BasePart::SetUniqueIdentifier ( const char *  identifier)

Sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open.

When set if the input value is the empty string a new unqiue uid is allocated for the part otherwise the supplied uid is used.
Created in NX6.0.5.

License requirements : None

Parameters
identifieridentifier
NXOpen::Display::TrueShadingCollection* NXOpen::BasePart::SHEDObjs ( )

Returns the Display.TrueShadingCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::SplineCollection* NXOpen::BasePart::Splines ( )

Returns the SplineCollection instance belonging to this part
Created in NX5.0.0.


NXOpen::Display::TrueStudioCollection* NXOpen::BasePart::TrueStudioObjs ( )

Returns the Display.TrueStudioCollection instance belonging to this part
Created in NX8.0.0.


NXString NXOpen::BasePart::UniqueIdentifier ( )

Returns the unique identifier for this part used to determine whether parts can be quietly substituted during part open.

When set if the input value is the empty string a new unqiue uid is allocated for the part otherwise the supplied uid is used.
Created in NX6.0.5.

License requirements : None

NXOpen::UnitCollection* NXOpen::BasePart::UnitCollection ( )

Returns a collection of Units
Created in NX3.0.0.


NXOpen::UserDefinedObjects::UserDefinedObjectManager* NXOpen::BasePart::UserDefinedObjectManager ( )

Returns the NXOpen::UserDefinedObjects::UserDefinedObjectManager belonging to this session
Created in NX3.0.0.


NXOpen::ValidationCollection* NXOpen::BasePart::Validations ( )

Returns the validation for this part
Created in NX3.0.0.


NXOpen::ViewCollection* NXOpen::BasePart::Views ( )

Returns the ViewCollection instance belonging to this part
Created in NX3.0.0.


NXOpen::WCS* NXOpen::BasePart::WCS ( )

Returns the WCS instance belonging to this part
Created in NX3.0.0.


NXOpen::XformCollection* NXOpen::BasePart::Xforms ( )

Returns the XformCollection instance belonging to this part
Created in NX3.0.0.



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