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

Inheritance diagram for NXOpen::Drawings::DraftingViewCollection:

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.

void	ConvertLegacyViewsToLightweight (const std::vector< NXOpen::Drawings::DraftingView * > &views)
	Converts legacy views to lightweight.

NXOpen::Drawings::AddRemoveBoxViewBuilder *	CreateAddRemoveBoxViewBuilder (NXOpen::Drawings::DraftingView *activeView)
	Creates a Drawings::AddRemoveBoxViewBuilder.

NXOpen::Drawings::BaseViewBuilder *	CreateBaseViewBuilder (NXOpen::Drawings::BaseView *view)
	Creates the Base View Builder.

NXOpen::Drawings::BrokenViewBuilder *	CreateBrokenViewBuilder (NXOpen::Drawings::ViewBreak *viewbreak)
	Creates a Drawings::BrokenViewBuilder.

NXOpen::Drawings::ViewCopyTo3dBuilder *	CreateCopyTo3dBuilder ()
	Creates a Drawings::ViewCopyTo3dBuilder.

NXOpen::Drawings::CustomViewSettingsBuilder *	CreateCustomViewSettingsBuilder ()
	Creates a Drawings::CustomViewSettingsBuilder.

NXOpen::Drawings::DetailViewBuilder *	CreateDetailViewBuilder (NXOpen::Drawings::DetailView *view)
	Creates a Drawings::DetailViewBuilder.

NXOpen::Drawings::DrawingViewBuilder *	CreateDrawingViewBuilder (NXOpen::Drawings::DrawingView *drawingview)
	Creates a DrawingViewBuilder.

NXOpen::Drawings::ProjectedViewBuilder *	CreateProjectedViewBuilder (NXOpen::Drawings::ProjectedView *view)
	Creates the Projected View Builder.

NXOpen::Drawings::RefineDisplayBuilder *	CreateRefineDisplayBuilder ()
	Creates a Drawings::RefineDisplayBuilder.

NXOpen::Drawings::SectionInViewBuilder *	CreateSectionInViewBuilder ()
	Creates the Section In View Builder.

NXOpen::Drawings::SectionViewBuilder *	CreateSectionViewBuilder (NXOpen::Drawings::SectionView *view)
	Creates the Section View Builder.

NXOpen::Drawings::ViewStyleShipbuildingLinesBuilder *	CreateShipbuildingLineBuilder ()
	Creates a Drawings::ViewStyleShipbuildingLinesBuilder.

NXOpen::Drawings::StandardViewsBuilder *	CreateStandardViewsBuilder ()
	Creates a StandardViewsBuilder.

NXOpen::Drawings::UpdateViewsBuilder *	CreateUpdateViewsBuilder ()
	Creates the Update Views Builder.

NXOpen::Drawings::ViewCreationWizardBuilder *	CreateViewCreationWizardBuilder ()
	Creates a Drawings::ViewCreationWizardBuilder.

NXOpen::Drawings::ViewProjectionBuilder *	CreateViewProjectionBuilder ()
	Creates a Drawings::ViewProjectionBuilder.

void	DeleteViewsInOriginalPart (const std::vector< NXOpen::Drawings::DraftingView * > &views)
	Deletes views in original part Created in NX8.0.0.

iterator	end ()
	Returns an iterator addressing one past the last element.

NXOpen::Drawings::DraftingView *	FindObject (const NXString &journalIdentifier)
	Finds the Drawings::DraftingView with the given identifier as recorded in a journal.

NXOpen::Drawings::DraftingView *	FindObject (const char *journalIdentifier)
	Finds the Drawings::DraftingView with the given identifier as recorded in a journal.

NXOpen::ModelingView *	GetParentOfView (NXOpen::View *view)
	Find the parent cut (sectioned) model view of a drawing member view.

void	MoveViewsToDrawing (const std::vector< NXOpen::Drawings::DraftingView * > &views, NXOpen::Drawings::DrawingSheet *drawing)
	Move views to drawing Created in NX7.5.0.

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.

void	RestoreViewBreaks (NXOpen::Drawings::DraftingView *view)
	Restore all view breaks of the view suppressed by Drawings::DraftingViewCollection::SuppressViewBreaks Created in NX8.0.0.

void	SuppressViewBreaks (NXOpen::Drawings::DraftingView *view)
	Suppress all view breaks of the view.

tag_t	Tag () const
	Returns the tag of this object.

void	UpdateViewBreaks (NXOpen::Drawings::DraftingView *view)
	Log all view breaks of the view for update Created in NX8.5.0.

void	UpdateViews (NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption updateOption)
	Updates drafting views in the part determined by an update option.

void	UpdateViews (NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption updateOption, NXOpen::Drawings::DrawingSheet *drawing)
	Updates drafting views in a sheet determined by an update option.

void	UpdateViews (const std::vector< NXOpen::Drawings::DraftingView * > &views)
	Updates the drafting views.

Detailed Description

Represents a collection of Drawings::DraftingView s.

<br> To obtain an instance of this class, refer to @link Part  Part @endlink  <br>

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::DraftingViewCollection::ViewCopyAnnotOption

Specifies the the annotation copy mode.

Enumerator:

ViewCopyAnnotOptionCopyAnnotation	copy annotation
ViewCopyAnnotOptionDontCopyAnnotation	don't copy annotation

enum NXOpen::Drawings::DraftingViewCollection::ViewCopyDetailOption

Specifies the the view copy mode.

Enumerator:

ViewCopyDetailOptionDetailView	detail view
ViewCopyDetailOptionDuplicateView	duplicate view
ViewCopyDetailOptionModelView	model view

enum NXOpen::Drawings::DraftingViewCollection::ViewUpdateOption

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

views views

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

Creates a Drawings::AddRemoveBoxViewBuilder.

Returns: Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

activeView the active view. Cannot be NULL.

NXOpen::Drawings::BaseViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateBaseViewBuilder ( NXOpen::Drawings::BaseView * view )

Creates the Base View Builder.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

view	the 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 Drawings::BrokenViewBuilder.

Returns: Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

viewbreak the view break to be edited, NULL in case of new broken view.

NXOpen::Drawings::ViewCopyTo3dBuilder* NXOpen::Drawings::DraftingViewCollection::CreateCopyTo3dBuilder ( )

Creates a Drawings::ViewCopyTo3dBuilder.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

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

Creates a Drawings::CustomViewSettingsBuilder.

Returns: Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

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

Creates a Drawings::DetailViewBuilder.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

view	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.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

drawingview the 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.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

view	the projected view to be edited, if NULL, then create a projected view

NXOpen::Drawings::RefineDisplayBuilder* NXOpen::Drawings::DraftingViewCollection::CreateRefineDisplayBuilder ( )

Creates a Drawings::RefineDisplayBuilder.

Returns: Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

NXOpen::Drawings::SectionInViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateSectionInViewBuilder ( )

Creates the Section In View Builder.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

NXOpen::Drawings::SectionViewBuilder* NXOpen::Drawings::DraftingViewCollection::CreateSectionViewBuilder ( NXOpen::Drawings::SectionView * view )

Creates the Section View Builder.

Returns: Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

view	the section view to be edited, if NULL, then create a section view

NXOpen::Drawings::ViewStyleShipbuildingLinesBuilder* NXOpen::Drawings::DraftingViewCollection::CreateShipbuildingLineBuilder ( )

Creates a 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.

Returns: Created in NX6.0.1.

License requirements : nx_drafting_plus ("DraftingPlus")

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

Creates the Update Views Builder.

Returns: Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

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

Creates a Drawings::ViewCreationWizardBuilder.

Returns: Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

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

Creates a Drawings::ViewProjectionBuilder.

Returns: Created in NX6.0.2.

License requirements : nx_drafting_plus ("DraftingPlus")

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

views views

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 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.  @return  View with this identifier

Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Identifier of the drafting view to be found

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

Finds the 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.  @return  View with this identifier

Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Identifier 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.  @return

Created in NX3.0.0.

License requirements : None

Parameters

view view

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

views	new views
drawing	the 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

drawing	the drawing which view in
views	old views
detailOption	detail copy option
annotOption	Annotation copy option
newViews	new 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

view view

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

view view

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

Returns the tag of this object.

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

view	View 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
       @link Drawings::DraftingViewCollection::ViewUpdateOptionOutOfDate Drawings::DraftingViewCollection::ViewUpdateOptionOutOfDate@endlink .

Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

updateOption View 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
       @link Drawings::DraftingViewCollection::ViewUpdateOptionOutOfDate Drawings::DraftingViewCollection::ViewUpdateOptionOutOfDate@endlink .

Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

updateOption	View update option
drawing	drawing

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

views views

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

Drawings_DraftingViewCollection.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation