ViewCollection Class¶

class NXOpen.ViewCollection¶

Bases: object

Represents a collection of :py:class:`NXOpen.View`s.

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

New in version NX3.0.0.

Properties¶

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

Methods¶

Method	Description
CreateBackground	Creates a `NXOpen.Display.Background`
CreateEnvironmentBuilder	Creates a `NXOpen.Display.EnvironmentBuilder`
CreateExtractScene	Creates a `NXOpen.Display.ExtractScene`
CreateGlobalIlluminationBuilder	Creates a `NXOpen.Display.GlobalIlluminationBuilder`
CreateImage	Creates a `NXOpen.Display.Image`
CreateImageBasedLighting	Creates a `NXOpen.Display.ImageBasedLighting`
CreateIrayPlusMaterialEditorBuilder	Creates a `NXOpen.Display.IrayPlusMaterialEditorBuilder`
CreateIrayPlusSimpleMaterialEditorBuilder	Creates a `NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder`
CreateIrayPlusStudioEditorBuilder	Creates a `NXOpen.Display.IRayPlusStudioEditorBuilder`
CreateLightBuilder	Creates a `NXOpen.Display.LightBuilder`
CreateLighting	Creates a `NXOpen.Display.Lighting`
CreateNonProportionalZoom	Creates a `NXOpen.Display.NonProportionalZoom`
CreateRayTracedStudioBuilder	Creates a `NXOpen.Display.RayTracedStudioBuilder`
CreateRayTracedStudioEditorBuilder	Creates a `NXOpen.Display.RayTracedStudioEditorBuilder`
CreateReflection	Creates a `NXOpen.Display.Reflection`
CreateSaveImageFileBrowserBuilder	Creates a `NXOpen.Display.SaveImageFileBrowserBuilder`
CreateScene	Creates a `NXOpen.Display.Scene`
CreateShadows	Creates a `NXOpen.Display.Shadows`
CreateStage	Creates a `NXOpen.Display.Stage`
CreateStudioImageCaptureBuilder	Creates a `NXOpen.Display.StudioImageCaptureBuilder`
CreateWall	Creates a `NXOpen.Display.Wall`
FindObject	Finds the `NXOpen.View` with the given identifier as recorded in a journal.
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.
GetActiveViews	Returns the active views in the view collection.
GetCustomViews	Returns a list of custom view names in the view collection.
GetDisclosedModelViews	Get disclosed model views in the given part.
GetDisclosedModelViewsAndPurposes	Get disclosed model views and their purposes in the given part.
IsWorkViewExpanded	Returns whether the work view of the given part is in expand state.
Refresh	Refreshes all the views in the current layout
Regenerate	Regenerates the display of each view in the current layout.
Save	Saves current view.
SaveAs	Saves a view with user specified name.
SaveAsPreservingCase	Preserve case for user defined view names.
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.
UpdateDisplay	Updates the display of each view in the current layout.

Property Detail¶

WorkView¶

ViewCollection.WorkView¶

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

Method Detail¶

CreateBackground¶

ViewCollection.CreateBackground¶

Creates a NXOpen.Display.Background

Signature CreateBackground(view, makeReferencedObjects)

Parameters:	view (`NXOpen.View`) – view to which background data will be associated makeReferencedObjects (bool) – true if referenced image object is to be created
Returns:
Return type:	`NXOpen.Display.Background`

New in version NX5.0.0.

License requirements: None.

CreateEnvironmentBuilder¶

ViewCollection.CreateEnvironmentBuilder¶

Creates a NXOpen.Display.EnvironmentBuilder

Signature CreateEnvironmentBuilder(view, makeReferencedObjects)

Parameters:	view (`NXOpen.View`) – view to which image-based lighting data will be associated makeReferencedObjects (bool) – true if referenced image object is to be created
Returns:
Return type:	`NXOpen.Display.EnvironmentBuilder`

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

CreateExtractScene¶

ViewCollection.CreateExtractScene¶

Creates a NXOpen.Display.ExtractScene

Signature CreateExtractScene(view)

Parameters:	view (`NXOpen.View`) – view to which to extract the scene data will be associated
Returns:
Return type:	`NXOpen.Display.ExtractScene`

New in version NX5.0.0.

License requirements: None.

CreateGlobalIlluminationBuilder¶

ViewCollection.CreateGlobalIlluminationBuilder¶

Creates a NXOpen.Display.GlobalIlluminationBuilder

Signature CreateGlobalIlluminationBuilder()

Returns:
Return type:	`NXOpen.Display.GlobalIlluminationBuilder`

New in version NX9.0.0.

License requirements: None.

CreateImage¶

ViewCollection.CreateImage¶

Creates a NXOpen.Display.Image

Signature CreateImage(view)

Parameters:	view (`NXOpen.View`) – view to which image data will be associated
Returns:
Return type:	`NXOpen.Display.Image`

New in version NX5.0.0.

License requirements: None.

CreateImageBasedLighting¶

ViewCollection.CreateImageBasedLighting¶

Creates a NXOpen.Display.ImageBasedLighting

Signature CreateImageBasedLighting(view, makeReferencedObjects)

Parameters:	view (`NXOpen.View`) – view to which image-based lighting data will be associated makeReferencedObjects (bool) – true if referenced image object is to be created
Returns:
Return type:	`NXOpen.Display.ImageBasedLighting`

New in version NX5.0.0.

License requirements: None.

CreateIrayPlusMaterialEditorBuilder¶

ViewCollection.CreateIrayPlusMaterialEditorBuilder¶

Creates a NXOpen.Display.IrayPlusMaterialEditorBuilder

Signature CreateIrayPlusMaterialEditorBuilder(materialName)

Parameters:	materialName (str) –
Returns:
Return type:	`NXOpen.Display.IrayPlusMaterialEditorBuilder`

New in version NX11.0.0.

License requirements: studio_render (“UG STUDIO RENDER”)

CreateIrayPlusSimpleMaterialEditorBuilder¶

ViewCollection.CreateIrayPlusSimpleMaterialEditorBuilder¶

Creates a NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder

Signature CreateIrayPlusSimpleMaterialEditorBuilder()

Returns:
Return type:	`NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder`

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

CreateIrayPlusStudioEditorBuilder¶

ViewCollection.CreateIrayPlusStudioEditorBuilder¶

Creates a NXOpen.Display.IRayPlusStudioEditorBuilder

Signature CreateIrayPlusStudioEditorBuilder()

Returns:
Return type:	`NXOpen.Display.IRayPlusStudioEditorBuilder`

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

CreateLightBuilder¶

ViewCollection.CreateLightBuilder¶

Creates a NXOpen.Display.LightBuilder

Signature CreateLightBuilder(light)

Parameters:	light (`NXOpen.Light`) – light for which data will be modified
Returns:
Return type:	`NXOpen.Display.LightBuilder`

New in version NX5.0.0.

License requirements: None.

CreateLighting¶

ViewCollection.CreateLighting¶

Creates a NXOpen.Display.Lighting

Signature CreateLighting(view)

Parameters:	view (`NXOpen.View`) – view to which lighting data will be associated
Returns:
Return type:	`NXOpen.Display.Lighting`

New in version NX5.0.0.

License requirements: None.

CreateNonProportionalZoom¶

ViewCollection.CreateNonProportionalZoom¶

Creates a NXOpen.Display.NonProportionalZoom

Signature CreateNonProportionalZoom()

Returns:
Return type:	`NXOpen.Display.NonProportionalZoom`

New in version NX7.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

CreateRayTracedStudioBuilder¶

ViewCollection.CreateRayTracedStudioBuilder¶

Creates a NXOpen.Display.RayTracedStudioBuilder

Signature CreateRayTracedStudioBuilder()

Returns:
Return type:	`NXOpen.Display.RayTracedStudioBuilder`

New in version NX9.0.0.

License requirements: None.

CreateRayTracedStudioEditorBuilder¶

ViewCollection.CreateRayTracedStudioEditorBuilder¶

Creates a NXOpen.Display.RayTracedStudioEditorBuilder

Signature CreateRayTracedStudioEditorBuilder()

Returns:
Return type:	`NXOpen.Display.RayTracedStudioEditorBuilder`

New in version NX9.0.0.

License requirements: None.

CreateReflection¶

ViewCollection.CreateReflection¶

Creates a NXOpen.Display.Reflection

Signature CreateReflection(view, makeReferencedObjects)

Parameters:	view (`NXOpen.View`) – view to which reflection data will be associated makeReferencedObjects (bool) – true if referenced image object is to be created
Returns:
Return type:	`NXOpen.Display.Reflection`

New in version NX5.0.0.

License requirements: None.

CreateSaveImageFileBrowserBuilder¶

ViewCollection.CreateSaveImageFileBrowserBuilder¶

Creates a NXOpen.Display.SaveImageFileBrowserBuilder

Signature CreateSaveImageFileBrowserBuilder()

Returns:
Return type:	`NXOpen.Display.SaveImageFileBrowserBuilder`

New in version NX9.0.0.

License requirements: None.

CreateScene¶

ViewCollection.CreateScene¶

Creates a NXOpen.Display.Scene

Signature CreateScene(view, makeReferencedObjects)

Parameters:	view (`NXOpen.View`) – view to which scene data will be associated makeReferencedObjects (bool) – true if scene objects are to be created
Returns:
Return type:	`NXOpen.Display.Scene`

New in version NX5.0.0.

License requirements: None.

CreateShadows¶

ViewCollection.CreateShadows¶

Creates a NXOpen.Display.Shadows

Signature CreateShadows(view)

Parameters:	view (`NXOpen.View`) – view to which shadows data will be associated
Returns:
Return type:	`NXOpen.Display.Shadows`

New in version NX7.5.3.

License requirements: None.

CreateStage¶

ViewCollection.CreateStage¶

Creates a NXOpen.Display.Stage

Signature CreateStage(view, makeReferencedObjects)

Parameters:	view (`NXOpen.View`) – view to which stage data will be associated makeReferencedObjects (bool) – true if first wall’s image object is to be created
Returns:
Return type:	`NXOpen.Display.Stage`

New in version NX5.0.0.

License requirements: None.

CreateStudioImageCaptureBuilder¶

ViewCollection.CreateStudioImageCaptureBuilder¶

Creates a NXOpen.Display.StudioImageCaptureBuilder

Signature CreateStudioImageCaptureBuilder()

Returns:
Return type:	`NXOpen.Display.StudioImageCaptureBuilder`

New in version NX6.0.4.

License requirements: None.

CreateWall¶

ViewCollection.CreateWall¶

Creates a NXOpen.Display.Wall

Signature CreateWall(view, wallType)

Parameters:	view (`NXOpen.View`) – view to which stage data will be associated wallType – where the wall sits in the Display.

Stage :type wallType: NXOpen.Display.StageWallType :returns: :rtype: NXOpen.Display.Wall

New in version NX5.0.0.

License requirements: None.

FindObject¶

ViewCollection.FindObject¶

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.

Signature FindObject(journalIdentifier)

Parameters:	journalIdentifier (str) – Identifier of the view to be found
Returns:	View with this identifier
Return type:	`NXOpen.View`

New in version NX3.0.0.

License requirements: None.

FitAll¶

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.

Signature FitAll()

New in version NX4.0.0.

License requirements: None.

GetActiveViews¶

ViewCollection.GetActiveViews¶

Returns the active views in the view collection.

Signature GetActiveViews()

Returns:	List of active views
Return type:	list of `NXOpen.View`

New in version NX3.0.0.

License requirements: None.

GetCustomViews¶

ViewCollection.GetCustomViews¶

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

Signature GetCustomViews()

Returns:	List of custom view names
Return type:	list of str

New in version NX3.0.0.

License requirements: None.

GetDisclosedModelViews¶

ViewCollection.GetDisclosedModelViews¶

Get disclosed model views in the given part.

Signature GetDisclosedModelViews()

Returns:
Return type:	list of `NXOpen.View`

New in version NX11.0.1.

License requirements: None.

GetDisclosedModelViewsAndPurposes¶

ViewCollection.GetDisclosedModelViewsAndPurposes¶

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

Signature GetDisclosedModelViewsAndPurposes()

Returns:	a tuple
Return type:	A tuple consisting of (disclosedViews, disclosurePurposes). disclosedViews is a list of `NXOpen.View`. disclosurePurposes is a list of str.

New in version NX11.0.1.

License requirements: None.

IsWorkViewExpanded¶

ViewCollection.IsWorkViewExpanded¶

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

Signature IsWorkViewExpanded()

Returns:	true if the work view is expanded
Return type:	bool

New in version NX4.0.0.

License requirements: None.

Refresh¶

ViewCollection.Refresh¶

Refreshes all the views in the current layout

Signature Refresh()

New in version NX3.0.0.

License requirements: None.

Regenerate¶

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.

Signature Regenerate()

New in version NX4.0.0.

License requirements: None.

Save¶

ViewCollection.Save¶

Saves current view.

Signature Save()

New in version NX3.0.0.

License requirements: None.

SaveAs¶

ViewCollection.SaveAs¶

Saves a view with user specified name.

Signature SaveAs(selectedView, newViewName, copyViewModifications, moveViewDependencies)

Parameters:	selectedView (`NXOpen.View`) – Selected view newViewName (str) – Selected name of the view copyViewModifications (bool) – True if view modifications to be copied moveViewDependencies (bool) – True if view dependencies to be moved
Returns:	Newly created view
Return type:	`NXOpen.View`

New in version NX3.0.0.

License requirements: None.

SaveAsPreservingCase¶

ViewCollection.SaveAsPreservingCase¶

Preserve case for user defined view names.

Signature SaveAsPreservingCase(selectedView, newViewName, copyViewModifications, moveViewDependencies)

Parameters:	selectedView (`NXOpen.View`) – Selected view newViewName (str) – Selected name of the view copyViewModifications (bool) – True if view modifications to be copied moveViewDependencies (bool) – True if view dependencies to be moved
Returns:	Newly created view
Return type:	`NXOpen.View`

New in version NX8.0.0.

License requirements: None.

UnexpandWork¶

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.

Signature UnexpandWork()

New in version NX4.0.0.

License requirements: None.

UpdateDisplay¶

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.

Signature UpdateDisplay()

New in version NX4.0.0.

License requirements: None.