Represents a collection of NXOpen::View s. More...

Inheritance diagram for NXOpen::ViewCollection:

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

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element. More...

NXOpen::Display::Background *	CreateBackground (NXOpen::View *view, bool makeReferencedObjects)
	Creates a NXOpen::Display::Background Created in NX5.0.0. More...

NXOpen::Display::EnvironmentBuilder *	CreateEnvironmentBuilder (NXOpen::View *view, bool makeReferencedObjects)
	Creates a NXOpen::Display::EnvironmentBuilder Created in NX10.0.2. More...

NXOpen::Display::ExtractScene *	CreateExtractScene (NXOpen::View *view)
	Creates a NXOpen::Display::ExtractScene Created in NX5.0.0. More...

NXOpen::Display::GlobalIlluminationBuilder *	CreateGlobalIlluminationBuilder ()
	Creates a NXOpen::Display::GlobalIlluminationBuilder Created in NX9.0.0. More...

NXOpen::Display::Image *	CreateImage (NXOpen::View *view)
	Creates a NXOpen::Display::Image Created in NX5.0.0. More...

NXOpen::Display::ImageBasedLighting *	CreateImageBasedLighting (NXOpen::View *view, bool makeReferencedObjects)
	Creates a NXOpen::Display::ImageBasedLighting Created in NX5.0.0. More...

NXOpen::Display::IrayPlusMaterialEditorBuilder *	CreateIrayPlusMaterialEditorBuilder (const NXString &materialName)
	Creates a NXOpen::Display::IrayPlusMaterialEditorBuilder Created in NX11.0.0. More...

NXOpen::Display::IrayPlusMaterialEditorBuilder *	CreateIrayPlusMaterialEditorBuilder (const char *materialName)
	Creates a NXOpen::Display::IrayPlusMaterialEditorBuilder Created in NX11.0.0. More...

NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder *	CreateIrayPlusSimpleMaterialEditorBuilder ()
	Creates a NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder *	CreateIrayPlusStudioEditorBuilder ()
	Creates a NXOpen::Display::IRayPlusStudioEditorBuilder Created in NX10.0.2. More...

NXOpen::Display::LightBuilder *	CreateLightBuilder (NXOpen::Light *light)
	Creates a NXOpen::Display::LightBuilder Created in NX5.0.0. More...

NXOpen::Display::Lighting *	CreateLighting (NXOpen::View *view)
	Creates a NXOpen::Display::Lighting Created in NX5.0.0. More...

NXOpen::Display::NonProportionalZoom *	CreateNonProportionalZoom ()
	Creates a NXOpen::Display::NonProportionalZoom Created in NX7.0.0. More...

NXOpen::Display::RayTracedStudioBuilder *	CreateRayTracedStudioBuilder ()
	Creates a NXOpen::Display::RayTracedStudioBuilder Created in NX9.0.0. More...

NXOpen::Display::RayTracedStudioEditorBuilder *	CreateRayTracedStudioEditorBuilder ()
	Creates a NXOpen::Display::RayTracedStudioEditorBuilder Created in NX9.0.0. More...

NXOpen::Display::Reflection *	CreateReflection (NXOpen::View *view, bool makeReferencedObjects)
	Creates a NXOpen::Display::Reflection Created in NX5.0.0. More...

NXOpen::Display::SaveImageFileBrowserBuilder *	CreateSaveImageFileBrowserBuilder ()
	Creates a NXOpen::Display::SaveImageFileBrowserBuilder Created in NX9.0.0. More...

NXOpen::Display::Scene *	CreateScene (NXOpen::View *view, bool makeReferencedObjects)
	Creates a NXOpen::Display::Scene Created in NX5.0.0. More...

NXOpen::Display::Shadows *	CreateShadows (NXOpen::View *view)
	Creates a NXOpen::Display::Shadows Created in NX7.5.3. More...

NXOpen::Display::Stage *	CreateStage (NXOpen::View *view, bool makeReferencedObjects)
	Creates a NXOpen::Display::Stage Created in NX5.0.0. More...

NXOpen::Display::StudioImageCaptureBuilder *	CreateStudioImageCaptureBuilder ()
	Creates a NXOpen::Display::StudioImageCaptureBuilder Created in NX6.0.4. More...

NXOpen::Display::Wall *	CreateWall (NXOpen::View *view, NXOpen::Display::Stage::WallType wallType)
	Creates a NXOpen::Display::Wall Created in NX5.0.0. More...

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

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

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

void	FitAll ()
	Adjusts the center and scale of each view in the current layout such that all of each view is visible, except that this fit operation is not applied to member views on a drawing. More...

std::vector< NXOpen::View * >	GetActiveViews ()
	Returns the active views in the view collection. More...

std::vector< NXString >	GetCustomViews ()
	Returns a list of custom view names in the view collection. More...

std::vector< NXOpen::View * >	GetDisclosedModelViews ()
	Get disclosed model views in the given part. More...

std::vector< NXOpen::View * >	GetDisclosedModelViewsAndPurposes (std::vector< NXString > &disclosurePurposes)
	Get disclosed model views and their purposes in the given part. More...

bool	IsWorkViewExpanded ()
	Returns whether the work view of the given part is in expand state. More...

void	Refresh ()
	Refreshes all the views in the current layout Created in NX3.0.0. More...

void	Regenerate ()
	Regenerates the display of each view in the current layout. More...

void	Save ()
	Saves current view. More...

NXOpen::View *	SaveAs (NXOpen::View *selectedView, const NXString &newViewName, bool copyViewModifications, bool moveViewDependencies)
	Saves a view with user specified name. More...

NXOpen::View *	SaveAs (NXOpen::View selectedView, const char newViewName, bool copyViewModifications, bool moveViewDependencies)
	Saves a view with user specified name. More...

NXOpen::View *	SaveAsPreservingCase (NXOpen::View *selectedView, const NXString &newViewName, bool copyViewModifications, bool moveViewDependencies)
	Preserve case for user defined view names. More...

NXOpen::View *	SaveAsPreservingCase (NXOpen::View selectedView, const char newViewName, bool copyViewModifications, bool moveViewDependencies)
	Preserve case for user defined view names. More...

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

void	UnexpandWork ()
	Removes the work view from the expand state (assuming that it is in that state), restoring it to its normal size in its layout. More...

void	UpdateDisplay ()
	Updates the display of each view in the current layout. More...

NXOpen::View *	WorkView ()
	Returns the work view of the part, which is the work view of the current layout of the part. More...

Detailed Description

Represents a collection of NXOpen::View s.

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

Created in NX3.0.0.

Member Function Documentation

iterator NXOpen::ViewCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Display::Background* NXOpen::ViewCollection::CreateBackground	(	NXOpen::View *	view,
		bool	makeReferencedObjects
	)

Creates a NXOpen::Display::Background
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which background data will be associated
makeReferencedObjects	true if referenced image object is to be created

NXOpen::Display::EnvironmentBuilder* NXOpen::ViewCollection::CreateEnvironmentBuilder	(	NXOpen::View *	view,
		bool	makeReferencedObjects
	)

Creates a NXOpen::Display::EnvironmentBuilder
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

view	view to which image-based lighting data will be associated
makeReferencedObjects	true if referenced image object is to be created

NXOpen::Display::ExtractScene* NXOpen::ViewCollection::CreateExtractScene ( NXOpen::View * view )

Creates a NXOpen::Display::ExtractScene
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which to extract the scene data will be associated

NXOpen::Display::GlobalIlluminationBuilder* NXOpen::ViewCollection::CreateGlobalIlluminationBuilder ( )

Creates a NXOpen::Display::GlobalIlluminationBuilder
Created in NX9.0.0.

License requirements : None

NXOpen::Display::Image* NXOpen::ViewCollection::CreateImage ( NXOpen::View * view )

Creates a NXOpen::Display::Image
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which image data will be associated

NXOpen::Display::ImageBasedLighting* NXOpen::ViewCollection::CreateImageBasedLighting	(	NXOpen::View *	view,
		bool	makeReferencedObjects
	)

Creates a NXOpen::Display::ImageBasedLighting
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which image-based lighting data will be associated
makeReferencedObjects	true if referenced image object is to be created

NXOpen::Display::IrayPlusMaterialEditorBuilder* NXOpen::ViewCollection::CreateIrayPlusMaterialEditorBuilder ( const NXString & materialName )

Creates a NXOpen::Display::IrayPlusMaterialEditorBuilder
Created in NX11.0.0.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

materialName materialname

NXOpen::Display::IrayPlusMaterialEditorBuilder* NXOpen::ViewCollection::CreateIrayPlusMaterialEditorBuilder ( const char * materialName )

Creates a NXOpen::Display::IrayPlusMaterialEditorBuilder
Created in NX11.0.0.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

materialName materialname

NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder* NXOpen::ViewCollection::CreateIrayPlusSimpleMaterialEditorBuilder ( )

Creates a NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder* NXOpen::ViewCollection::CreateIrayPlusStudioEditorBuilder ( )

Creates a NXOpen::Display::IRayPlusStudioEditorBuilder
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::LightBuilder* NXOpen::ViewCollection::CreateLightBuilder ( NXOpen::Light * light )

Creates a NXOpen::Display::LightBuilder
Created in NX5.0.0.

License requirements : None

Parameters

light light for which data will be modified

NXOpen::Display::Lighting* NXOpen::ViewCollection::CreateLighting ( NXOpen::View * view )

Creates a NXOpen::Display::Lighting
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which lighting data will be associated

NXOpen::Display::NonProportionalZoom* NXOpen::ViewCollection::CreateNonProportionalZoom ( )

Creates a NXOpen::Display::NonProportionalZoom
Created in NX7.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::Display::RayTracedStudioBuilder* NXOpen::ViewCollection::CreateRayTracedStudioBuilder ( )

Creates a NXOpen::Display::RayTracedStudioBuilder
Created in NX9.0.0.

License requirements : None

NXOpen::Display::RayTracedStudioEditorBuilder* NXOpen::ViewCollection::CreateRayTracedStudioEditorBuilder ( )

Creates a NXOpen::Display::RayTracedStudioEditorBuilder
Created in NX9.0.0.

License requirements : None

NXOpen::Display::Reflection* NXOpen::ViewCollection::CreateReflection	(	NXOpen::View *	view,
		bool	makeReferencedObjects
	)

Creates a NXOpen::Display::Reflection
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which reflection data will be associated
makeReferencedObjects	true if referenced image object is to be created

NXOpen::Display::SaveImageFileBrowserBuilder* NXOpen::ViewCollection::CreateSaveImageFileBrowserBuilder ( )

Creates a NXOpen::Display::SaveImageFileBrowserBuilder
Created in NX9.0.0.

License requirements : None

NXOpen::Display::Scene* NXOpen::ViewCollection::CreateScene	(	NXOpen::View *	view,
		bool	makeReferencedObjects
	)

Creates a NXOpen::Display::Scene
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which scene data will be associated
makeReferencedObjects	true if scene objects are to be created

NXOpen::Display::Shadows* NXOpen::ViewCollection::CreateShadows ( NXOpen::View * view )

Creates a NXOpen::Display::Shadows
Created in NX7.5.3.

License requirements : None

Parameters

view	view to which shadows data will be associated

NXOpen::Display::Stage* NXOpen::ViewCollection::CreateStage	(	NXOpen::View *	view,
		bool	makeReferencedObjects
	)

Creates a NXOpen::Display::Stage
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which stage data will be associated
makeReferencedObjects	true if first wall's image object is to be created

NXOpen::Display::StudioImageCaptureBuilder* NXOpen::ViewCollection::CreateStudioImageCaptureBuilder ( )

Creates a NXOpen::Display::StudioImageCaptureBuilder
Created in NX6.0.4.

License requirements : None

NXOpen::Display::Wall* NXOpen::ViewCollection::CreateWall	(	NXOpen::View *	view,
		NXOpen::Display::Stage::WallType	wallType
	)

Creates a NXOpen::Display::Wall
Created in NX5.0.0.

License requirements : None

Parameters

view	view to which stage data will be associated
wallType	where the wall sits in the Display.Stage

iterator NXOpen::ViewCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::View* NXOpen::ViewCollection::FindObject ( const NXString & journalIdentifier )

Finds the NXOpen::View 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

journalIdentifier Identifier of the view to be found

NXOpen::View* NXOpen::ViewCollection::FindObject ( const char * journalIdentifier )

Finds the NXOpen::View 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

journalIdentifier Identifier of the view to be found

void NXOpen::ViewCollection::FitAll ( )

Adjusts the center and scale of each view in the current layout such that all of each view is visible, except that this fit operation is not applied to member views on a drawing.

If the work view is in expand state when this method is called, the work view is unexpanded before all of the views are fit.
In batch mode, the data for each view is updated, but no display occurs.

Created in NX4.0.0.

License requirements : None

std::vector<NXOpen::View *> NXOpen::ViewCollection::GetActiveViews ( )

Returns the active views in the view collection.

Returns: List of active views
Created in NX3.0.0.

License requirements : None

std::vector<NXString> NXOpen::ViewCollection::GetCustomViews ( )

Returns a list of custom view names in the view collection.

Returns: List of custom view names
Created in NX3.0.0.

License requirements : None

std::vector<NXOpen::View *> NXOpen::ViewCollection::GetDisclosedModelViews ( )

Get disclosed model views in the given part.

Created in NX11.0.1.

License requirements : None

std::vector<NXOpen::View *> NXOpen::ViewCollection::GetDisclosedModelViewsAndPurposes ( std::vector< NXString > & disclosurePurposes )

Get disclosed model views and their purposes in the given part.

Created in NX11.0.1.

License requirements : None

Parameters

disclosurePurposes disclosurepurposes

bool NXOpen::ViewCollection::IsWorkViewExpanded ( )

Returns whether the work view of the given part is in expand state.

Returns: true if the work view is expanded
Created in NX4.0.0.

License requirements : None

void NXOpen::ViewCollection::Refresh ( )

Refreshes all the views in the current layout
Created in NX3.0.0.

License requirements : None

void NXOpen::ViewCollection::Regenerate ( )

Regenerates the display of each view in the current layout.

The current scale of each view is used in determing the tolerances for rendering curves and facets within the view.
In batch mode, the state of each view is updated, but no display occurs.

Created in NX4.0.0.

License requirements : None

void NXOpen::ViewCollection::Save ( )

Saves current view.

Created in NX3.0.0.

License requirements : None

NXOpen::View* NXOpen::ViewCollection::SaveAs	(	NXOpen::View *	selectedView,
		const NXString &	newViewName,
		bool	copyViewModifications,
		bool	moveViewDependencies
	)

Saves a view with user specified name.

Returns: Newly created view
Created in NX3.0.0.

License requirements : None

Parameters

selectedView	Selected view
newViewName	Selected name of the view
copyViewModifications	True if view modifications to be copied
moveViewDependencies	True if view dependencies to be moved

NXOpen::View* NXOpen::ViewCollection::SaveAs	(	NXOpen::View *	selectedView,
		const char *	newViewName,
		bool	copyViewModifications,
		bool	moveViewDependencies
	)

Saves a view with user specified name.

Returns: Newly created view
Created in NX3.0.0.

License requirements : None

Parameters

selectedView	Selected view
newViewName	Selected name of the view
copyViewModifications	True if view modifications to be copied
moveViewDependencies	True if view dependencies to be moved

NXOpen::View* NXOpen::ViewCollection::SaveAsPreservingCase	(	NXOpen::View *	selectedView,
		const NXString &	newViewName,
		bool	copyViewModifications,
		bool	moveViewDependencies
	)

Preserve case for user defined view names.

Returns: Newly created view
Created in NX8.0.0.

License requirements : None

Parameters

selectedView	Selected view
newViewName	Selected name of the view
copyViewModifications	True if view modifications to be copied
moveViewDependencies	True if view dependencies to be moved

NXOpen::View* NXOpen::ViewCollection::SaveAsPreservingCase	(	NXOpen::View *	selectedView,
		const char *	newViewName,
		bool	copyViewModifications,
		bool	moveViewDependencies
	)

Preserve case for user defined view names.

Returns: Newly created view
Created in NX8.0.0.

License requirements : None

Parameters

selectedView	Selected view
newViewName	Selected name of the view
copyViewModifications	True if view modifications to be copied
moveViewDependencies	True if view dependencies to be moved

tag_t NXOpen::ViewCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::ViewCollection::UnexpandWork ( )

Removes the work view from the expand state (assuming that it is in that state), restoring it to its normal size in its layout.

Other views in the layout become visible again. If the work view is not in expand state, an error is returned. The view remains the work view unless the view is a member view on a drawing sheet, in which case the sheet's view becomes the work view. The given part must be the displayed part.
In batch mode, the internal state of the view is no longer in expand state, but no display occurs.

Created in NX4.0.0.

License requirements : None

void NXOpen::ViewCollection::UpdateDisplay ( )

Updates the display of each view in the current layout.

This method redisplays those objects whose display has become out of date due to rotations of the view or increases in view scale. For example: Following a rotation, the silhouettes of bodies in wireframe mode will be updated; Following a significant scale increase, the faces of a body in shaded mode will be tessalated with tighter tolerances.
In batch mode, the state of each view is updated, but no display occurs.

Created in NX4.0.0.

License requirements : None

NXOpen::View* NXOpen::ViewCollection::WorkView ( )

Returns the work view of the part, which is the work view of the current layout of the part.

See also NXOpen::Layout::WorkView .
Created in NX3.0.0.

License requirements : None

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

ViewCollection.hxx

Classes

Public Member Functions

Detailed Description

Member Function Documentation