NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Drawings::DraftingViewCollection Class Reference

Represents a collection of NXOpen::Drawings::DraftingView s. More...

Inheritance diagram for NXOpen::Drawings::DraftingViewCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Types

enum  ViewCopyAnnotOption { ViewCopyAnnotOptionCopyAnnotation, ViewCopyAnnotOptionDontCopyAnnotation }
 Specifies the the annotation copy mode. More...
 
enum  ViewCopyDetailOption { ViewCopyDetailOptionDetailView, ViewCopyDetailOptionDuplicateView, ViewCopyDetailOptionModelView }
 Specifies the the view copy mode. More...
 
enum  ViewUpdateOption { ViewUpdateOptionAll, ViewUpdateOptionOutOfDate, ViewUpdateOptionOutOfDateAutomatic }
 Specifies which drafting views to update. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
void ConvertLegacyViewsToLightweight (const std::vector< NXOpen::Drawings::DraftingView * > &views)
 Converts legacy views to lightweight. More...
 
NXOpen::Drawings::AddRemoveBoxViewBuilderCreateAddRemoveBoxViewBuilder (NXOpen::Drawings::DraftingView *activeView)
 Creates a NXOpen::Drawings::AddRemoveBoxViewBuilder
Created in NX8.0.0. More...
 
NXOpen::Drawings::BaseViewBuilderCreateBaseViewBuilder (NXOpen::Drawings::BaseView *view)
 Creates the Base View Builder
Created in NX6.0.0. More...
 
NXOpen::Drawings::BrokenViewBuilderCreateBrokenViewBuilder (NXOpen::Drawings::ViewBreak *viewbreak)
 Creates a NXOpen::Drawings::BrokenViewBuilder
Created in NX7.5.0. More...
 
NXOpen::Drawings::ViewCopyTo3dBuilderCreateCopyTo3dBuilder ()
 Creates a NXOpen::Drawings::ViewCopyTo3dBuilder
Created in NX6.0.0. More...
 
NXOpen::Drawings::CustomViewSettingsBuilderCreateCustomViewSettingsBuilder ()
 Creates a NXOpen::Drawings::CustomViewSettingsBuilder
Created in NX8.5.0. More...
 
NXOpen::Drawings::DetailViewBuilderCreateDetailViewBuilder (NXOpen::Drawings::DetailView *view)
 Creates a NXOpen::Drawings::DetailViewBuilder
Created in NX6.0.0. More...
 
NXOpen::Drawings::DrawingViewBuilderCreateDrawingViewBuilder (NXOpen::Drawings::DrawingView *drawingview)
 Creates a DrawingViewBuilder
Created in NX6.0.0. More...
 
NXOpen::Drawings::ProjectedViewBuilderCreateProjectedViewBuilder (NXOpen::Drawings::ProjectedView *view)
 Creates the Projected View Builder
Created in NX6.0.0. More...
 
NXOpen::Drawings::RefineDisplayBuilderCreateRefineDisplayBuilder ()
 Creates a NXOpen::Drawings::RefineDisplayBuilder
Created in NX8.0.0. More...
 
NXOpen::Drawings::SecondaryGeometryInViewsBuilderCreateSecondaryGeometryInViewsBuilder ()
 Creates a NXOpen::Drawings::SecondaryGeometryInViewsBuilder. More...
 
NXOpen::Drawings::SectionInViewBuilderCreateSectionInViewBuilder ()
 Creates the Section In View Builder
Created in NX6.0.0. More...
 
NXOpen::Drawings::SectionViewBuilderCreateSectionViewBuilder (NXOpen::NXObject *sectionViewOrSectionLine)
 Creates the Section View Builder
Created in NX6.0.0. More...
 
NXOpen::Drawings::ViewStyleShipbuildingLinesBuilderCreateShipbuildingLineBuilder ()
 Creates a NXOpen::Drawings::ViewStyleShipbuildingLinesBuilder. More...
 
NXOpen::Drawings::StandardViewsBuilderCreateStandardViewsBuilder ()
 Creates a StandardViewsBuilder
Created in NX6.0.1. More...
 
NXOpen::Drawings::UpdateViewsBuilderCreateUpdateViewsBuilder ()
 Creates the Update Views Builder
Created in NX5.0.0. More...
 
NXOpen::Drawings::ViewCreationWizardBuilderCreateViewCreationWizardBuilder ()
 Creates a NXOpen::Drawings::ViewCreationWizardBuilder
Created in NX8.0.0. More...
 
NXOpen::Drawings::ViewProjectionBuilderCreateViewProjectionBuilder ()
 Creates a NXOpen::Drawings::ViewProjectionBuilder
Created in NX6.0.2. More...
 
void DeleteViewsInOriginalPart (const std::vector< NXOpen::Drawings::DraftingView * > &views)
 Deletes views in original part
Created in NX8.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Drawings::DraftingViewFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Drawings::DraftingView with the given identifier as recorded in a journal. More...
 
NXOpen::Drawings::DraftingViewFindObject (const char *journalIdentifier)
 Finds the NXOpen::Drawings::DraftingView with the given identifier as recorded in a journal. More...
 
NXOpen::ModelingViewGetParentOfView (NXOpen::View *view)
 Find the parent cut (sectioned) model view of a drawing member view. More...
 
void MoveViewsToDrawing (const std::vector< NXOpen::Drawings::DraftingView * > &views, NXOpen::Drawings::DrawingSheet *drawing)
 Move views to drawing
Created in NX7.5.0. More...
 
void PasteViews (NXOpen::Drawings::DrawingSheet *drawing, const std::vector< NXOpen::Drawings::DraftingView * > &views, NXOpen::Drawings::DraftingViewCollection::ViewCopyDetailOption detailOption, NXOpen::Drawings::DraftingViewCollection::ViewCopyAnnotOption annotOption, std::vector< NXOpen::Drawings::DraftingView * > &newViews)
 Paste views
Created in NX7.5.0. More...
 
void RestoreViewBreaks (NXOpen::Drawings::DraftingView *view)
 Restore all view breaks of the view suppressed by Drawings::DraftingViewCollection::SuppressViewBreaks
Created in NX8.0.0. More...
 
void SuppressViewBreaks (NXOpen::Drawings::DraftingView *view)
 Suppress all view breaks of the view. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UpdateSheetsAndViews (const std::vector< NXOpen::NXObject * > &inputViews)
 Updates the drawing sheets and drafting views. More...
 
void UpdateViewBreaks (NXOpen::Drawings::DraftingView *view)
 Log all view breaks of the view for update
Created in NX8.5.0. More...
 
void UpdateViews (NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption updateOption)
 Updates drafting views in the part determined by an update option. More...
 
void UpdateViews (NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption updateOption, NXOpen::Drawings::DrawingSheet *drawing)
 Updates drafting views in a sheet determined by an update option. More...
 
void UpdateViews (const std::vector< NXOpen::Drawings::DraftingView * > &views)
 Updates the drafting views. More...
 

Detailed Description

Represents a collection of NXOpen::Drawings::DraftingView s.


To obtain an instance of this class, refer to NXOpen::Part

Created in NX3.0.0.

Member Enumeration Documentation

Specifies the the annotation copy mode.

Enumerator
ViewCopyAnnotOptionCopyAnnotation 

copy annotation

ViewCopyAnnotOptionDontCopyAnnotation 

don't copy annotation

Specifies the the view copy mode.

Enumerator
ViewCopyDetailOptionDetailView 

detail view

ViewCopyDetailOptionDuplicateView 

duplicate view

ViewCopyDetailOptionModelView 

model view

Specifies which drafting views to update.

Enumerator
ViewUpdateOptionAll 

Updates all views in scope (part or drawing sheet).

ViewUpdateOptionOutOfDate 

Updates all out of date views in scope (part or drawing sheet).

ViewUpdateOptionOutOfDateAutomatic 

Updates all out of date automatic views in scope (part or drawing sheet).

Member Function Documentation

iterator NXOpen::Drawings::DraftingViewCollection::begin ( )

Returns an iterator addressing the first element.

void NXOpen::Drawings::DraftingViewCollection::ConvertLegacyViewsToLightweight ( const std::vector< NXOpen::Drawings::DraftingView * > &  views)

Converts legacy views to lightweight.

The views in list can be spread amongst multiple sheets, but they must all belong to the same part.


Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters
viewsviews
NXOpen::Drawings::AddRemoveBoxViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateAddRemoveBoxViewBuilder ( NXOpen::Drawings::DraftingView activeView)

Creates a NXOpen::Drawings::AddRemoveBoxViewBuilder
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
activeViewthe active view. Cannot be NULL.
NXOpen::Drawings::BaseViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateBaseViewBuilder ( NXOpen::Drawings::BaseView view)

Creates the Base View Builder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
viewthe base view to be edited, if NULL, then create a base view
NXOpen::Drawings::BrokenViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateBrokenViewBuilder ( NXOpen::Drawings::ViewBreak viewbreak)

Creates a NXOpen::Drawings::BrokenViewBuilder
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
viewbreakthe view break to be edited, NULL in case of new broken view.
NXOpen::Drawings::ViewCopyTo3dBuilder* NXOpen::Drawings::DraftingViewCollection::CreateCopyTo3dBuilder ( )

Creates a NXOpen::Drawings::ViewCopyTo3dBuilder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::Drawings::CustomViewSettingsBuilder* NXOpen::Drawings::DraftingViewCollection::CreateCustomViewSettingsBuilder ( )

Creates a NXOpen::Drawings::CustomViewSettingsBuilder
Created in NX8.5.0.



License requirements : drafting ("DRAFTING")

NXOpen::Drawings::DetailViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateDetailViewBuilder ( NXOpen::Drawings::DetailView view)

Creates a NXOpen::Drawings::DetailViewBuilder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
viewNXOpen::Drawings::DetailView to be edited, if NULL then create a new one
NXOpen::Drawings::DrawingViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateDrawingViewBuilder ( NXOpen::Drawings::DrawingView drawingview)

Creates a DrawingViewBuilder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
drawingviewthe drawing view to be edited, if NULL, then create a drawing view
NXOpen::Drawings::ProjectedViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateProjectedViewBuilder ( NXOpen::Drawings::ProjectedView view)

Creates the Projected View Builder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
viewthe projected view to be edited, if NULL, then create a projected view
NXOpen::Drawings::RefineDisplayBuilder* NXOpen::Drawings::DraftingViewCollection::CreateRefineDisplayBuilder ( )

Creates a NXOpen::Drawings::RefineDisplayBuilder
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::Drawings::SecondaryGeometryInViewsBuilder* NXOpen::Drawings::DraftingViewCollection::CreateSecondaryGeometryInViewsBuilder ( )

Creates a NXOpen::Drawings::SecondaryGeometryInViewsBuilder.

Returns
Returns the Secondary Geometry In Views builder
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")
NXOpen::Drawings::SectionInViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateSectionInViewBuilder ( )

Creates the Section In View Builder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::Drawings::SectionViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateSectionViewBuilder ( NXOpen::NXObject sectionViewOrSectionLine)

Creates the Section View Builder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
sectionViewOrSectionLinethe section view or section line to be edited, if NULL, then create a section view or section line
NXOpen::Drawings::ViewStyleShipbuildingLinesBuilder* NXOpen::Drawings::DraftingViewCollection::CreateShipbuildingLineBuilder ( )

Creates a NXOpen::Drawings::ViewStyleShipbuildingLinesBuilder.

Returns
Returns the empty Shipbuilding Lines sub-builder on View Style
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")
NXOpen::Drawings::StandardViewsBuilder* NXOpen::Drawings::DraftingViewCollection::CreateStandardViewsBuilder ( )

Creates a StandardViewsBuilder
Created in NX6.0.1.



License requirements : nx_layout ("NX Layout")

NXOpen::Drawings::UpdateViewsBuilder* NXOpen::Drawings::DraftingViewCollection::CreateUpdateViewsBuilder ( )

Creates the Update Views Builder
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::Drawings::ViewCreationWizardBuilder* NXOpen::Drawings::DraftingViewCollection::CreateViewCreationWizardBuilder ( )

Creates a NXOpen::Drawings::ViewCreationWizardBuilder
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::Drawings::ViewProjectionBuilder* NXOpen::Drawings::DraftingViewCollection::CreateViewProjectionBuilder ( )

Creates a NXOpen::Drawings::ViewProjectionBuilder
Created in NX6.0.2.



License requirements : nx_layout ("NX Layout")

void NXOpen::Drawings::DraftingViewCollection::DeleteViewsInOriginalPart ( const std::vector< NXOpen::Drawings::DraftingView * > &  views)

Deletes views in original part
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
viewsviews
iterator NXOpen::Drawings::DraftingViewCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Drawings::DraftingView* NXOpen::Drawings::DraftingViewCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Drawings::DraftingView with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
View with this identifier
Created in NX3.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the drafting view to be found
NXOpen::Drawings::DraftingView* NXOpen::Drawings::DraftingViewCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Drawings::DraftingView with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
View with this identifier
Created in NX3.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the drafting view to be found
NXOpen::ModelingView* NXOpen::Drawings::DraftingViewCollection::GetParentOfView ( NXOpen::View view)

Find the parent cut (sectioned) model view of a drawing member view.

If the parent view is not a cut model view, NULL is returned.
Created in NX3.0.0.

License requirements : None

Parameters
viewview
void NXOpen::Drawings::DraftingViewCollection::MoveViewsToDrawing ( const std::vector< NXOpen::Drawings::DraftingView * > &  views,
NXOpen::Drawings::DrawingSheet drawing 
)

Move views to drawing
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
viewsnew views
drawingthe drawing which view will in
void NXOpen::Drawings::DraftingViewCollection::PasteViews ( NXOpen::Drawings::DrawingSheet drawing,
const std::vector< NXOpen::Drawings::DraftingView * > &  views,
NXOpen::Drawings::DraftingViewCollection::ViewCopyDetailOption  detailOption,
NXOpen::Drawings::DraftingViewCollection::ViewCopyAnnotOption  annotOption,
std::vector< NXOpen::Drawings::DraftingView * > &  newViews 
)

Paste views
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
drawingthe drawing which view in
viewsold views
detailOptiondetail copy option
annotOptionAnnotation copy option
newViewsnew views
void NXOpen::Drawings::DraftingViewCollection::RestoreViewBreaks ( NXOpen::Drawings::DraftingView view)

Restore all view breaks of the view suppressed by Drawings::DraftingViewCollection::SuppressViewBreaks
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
viewview
void NXOpen::Drawings::DraftingViewCollection::SuppressViewBreaks ( NXOpen::Drawings::DraftingView view)

Suppress all view breaks of the view.

It is neccessary if we want change the view contents
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
viewview
tag_t NXOpen::Drawings::DraftingViewCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::Drawings::DraftingViewCollection::UpdateSheetsAndViews ( const std::vector< NXOpen::NXObject * > &  inputViews)

Updates the drawing sheets and drafting views.

The views in list can be spread amongst multiple sheets, but they must all belong to the same part.


Created in NX1847.0.0.

License requirements : drafting ("DRAFTING")

Parameters
inputViewssheet and/or views
void NXOpen::Drawings::DraftingViewCollection::UpdateViewBreaks ( NXOpen::Drawings::DraftingView view)

Log all view breaks of the view for update
Created in NX8.5.0.



License requirements : drafting ("DRAFTING")

Parameters
viewView in which view breaks will be updated
void NXOpen::Drawings::DraftingViewCollection::UpdateViews ( NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption  updateOption)

Updates drafting views in the part determined by an update option.

For example, to update all out of date views in a part, pass in Drawings::DraftingViewCollection::ViewUpdateOptionOutOfDate .


Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters
updateOptionView update option
void NXOpen::Drawings::DraftingViewCollection::UpdateViews ( NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption  updateOption,
NXOpen::Drawings::DrawingSheet drawing 
)

Updates drafting views in a sheet determined by an update option.

For example, to update all out of date views on the sheet, pass in Drawings::DraftingViewCollection::ViewUpdateOptionOutOfDate .


Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters
updateOptionView update option
drawingdrawing
void NXOpen::Drawings::DraftingViewCollection::UpdateViews ( const std::vector< NXOpen::Drawings::DraftingView * > &  views)

Updates the drafting views.

The views in list can be spread amongst multiple sheets, but they must all belong to the same part.


Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters
viewsviews

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