NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.ViewCollection Class Reference

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

Inheritance diagram for NXOpen.ViewCollection:

Public Member Functions

NXOpen.View[] ToArray ()
 Returns an array of NXOpen.View objects. More...
 
unsafe void Refresh ()
 Refreshes all the views in the current layout More...
 
unsafe NXOpen.View[] GetActiveViews ()
 Returns the active views in the view collection. More...
 
unsafe string[] GetCustomViews ()
 Returns a list of custom view names in the view collection. More...
 
unsafe bool IsWorkViewExpanded ()
 Returns whether the work view of the given part is in expand state. More...
 
unsafe NXOpen.View SaveAs (NXOpen.View selectedView, string newViewName, bool copyViewModifications, bool moveViewDependencies)
 Saves a view with user specified name. More...
 
unsafe void Save ()
 Saves current view. More...
 
unsafe NXOpen.View FindObject (string journalIdentifier)
 Finds the NXOpen.View with the given identifier as recorded in a journal. More...
 
unsafe 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...
 
unsafe 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...
 
unsafe void Regenerate ()
 Regenerates the display of each view in the current layout. More...
 
unsafe void UpdateDisplay ()
 Updates the display of each view in the current layout. More...
 
unsafe NXOpen.Display.Scene CreateScene (NXOpen.View view, bool makeReferencedObjects)
 Creates a NXOpen.Display.Scene More...
 
unsafe NXOpen.Display.Background CreateBackground (NXOpen.View view, bool makeReferencedObjects)
 Creates a NXOpen.Display.Background More...
 
unsafe NXOpen.Display.Shadows CreateShadows (NXOpen.View view)
 Creates a NXOpen.Display.Shadows More...
 
unsafe NXOpen.Display.Image CreateImage (NXOpen.View view)
 Creates a NXOpen.Display.Image More...
 
unsafe NXOpen.Display.Stage CreateStage (NXOpen.View view, bool makeReferencedObjects)
 Creates a NXOpen.Display.Stage More...
 
unsafe NXOpen.Display.Wall CreateWall (NXOpen.View view, NXOpen.Display.Stage.WallType wallType)
 Creates a NXOpen.Display.Wall More...
 
unsafe NXOpen.Display.Reflection CreateReflection (NXOpen.View view, bool makeReferencedObjects)
 Creates a NXOpen.Display.Reflection More...
 
unsafe NXOpen.Display.Lighting CreateLighting (NXOpen.View view)
 Creates a NXOpen.Display.Lighting More...
 
unsafe NXOpen.Display.LightBuilder CreateLightBuilder (NXOpen.Light light)
 Creates a NXOpen.Display.LightBuilder More...
 
unsafe
NXOpen.Display.ImageBasedLighting 
CreateImageBasedLighting (NXOpen.View view, bool makeReferencedObjects)
 Creates a NXOpen.Display.ImageBasedLighting More...
 
unsafe NXOpen.Display.ExtractScene CreateExtractScene (NXOpen.View view)
 Creates a NXOpen.Display.ExtractScene More...
 
unsafe
NXOpen.Display.NonProportionalZoom 
CreateNonProportionalZoom ()
 Creates a NXOpen.Display.NonProportionalZoom More...
 
unsafe
NXOpen.Display.StudioImageCaptureBuilder 
CreateStudioImageCaptureBuilder ()
 Creates a NXOpen.Display.StudioImageCaptureBuilder More...
 
unsafe NXOpen.View SaveAsPreservingCase (NXOpen.View selectedView, string newViewName, bool copyViewModifications, bool moveViewDependencies)
 Preserve case for user defined view names. More...
 
unsafe
NXOpen.Display.RayTracedStudioBuilder 
CreateRayTracedStudioBuilder ()
 Creates a NXOpen.Display.RayTracedStudioBuilder More...
 
unsafe
NXOpen.Display.SaveImageFileBrowserBuilder 
CreateSaveImageFileBrowserBuilder ()
 Creates a NXOpen.Display.SaveImageFileBrowserBuilder More...
 
unsafe
NXOpen.Display.GlobalIlluminationBuilder 
CreateGlobalIlluminationBuilder ()
 Creates a NXOpen.Display.GlobalIlluminationBuilder More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder 
CreateRayTracedStudioEditorBuilder ()
 Creates a NXOpen.Display.RayTracedStudioEditorBuilder More...
 
unsafe
NXOpen.Display.EnvironmentBuilder 
CreateEnvironmentBuilder (NXOpen.View view, bool makeReferencedObjects)
 Creates a NXOpen.Display.EnvironmentBuilder More...
 
unsafe
NXOpen.Display.IRayPlusStudioEditorBuilder 
CreateIrayPlusStudioEditorBuilder ()
 Creates a NXOpen.Display.IRayPlusStudioEditorBuilder More...
 
unsafe
NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder 
CreateIrayPlusSimpleMaterialEditorBuilder ()
 Creates a NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder More...
 
unsafe
NXOpen.Display.IrayPlusMaterialEditorBuilder 
CreateIrayPlusMaterialEditorBuilder (string materialName)
 Creates a NXOpen.Display.IrayPlusMaterialEditorBuilder More...
 
unsafe NXOpen.View[] GetDisclosedModelViews ()
 Get disclosed model views in the given part. More...
 
unsafe NXOpen.View[] GetDisclosedModelViewsAndPurposes (out string[] disclosurePurposes)
 Get disclosed model views and their purposes in the given part. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
unsafe NXOpen.View WorkView [get]
 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

unsafe 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
viewview to which background data will be associated
makeReferencedObjectstrue if referenced image object is to be created
Returns
unsafe 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
viewview to which image-based lighting data will be associated
makeReferencedObjectstrue if referenced image object is to be created
Returns
unsafe NXOpen.Display.ExtractScene NXOpen.ViewCollection.CreateExtractScene ( NXOpen.View  view)

Creates a NXOpen.Display.ExtractScene

Created in NX5.0.0

License requirements: None.

Parameters
viewview to which to extract the scene data will be associated
Returns
unsafe NXOpen.Display.GlobalIlluminationBuilder NXOpen.ViewCollection.CreateGlobalIlluminationBuilder ( )

Creates a NXOpen.Display.GlobalIlluminationBuilder

Created in NX9.0.0

License requirements: None.

Returns
unsafe NXOpen.Display.Image NXOpen.ViewCollection.CreateImage ( NXOpen.View  view)

Creates a NXOpen.Display.Image

Created in NX5.0.0

License requirements: None.

Parameters
viewview to which image data will be associated
Returns
unsafe 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
viewview to which image-based lighting data will be associated
makeReferencedObjectstrue if referenced image object is to be created
Returns
unsafe NXOpen.Display.IrayPlusMaterialEditorBuilder NXOpen.ViewCollection.CreateIrayPlusMaterialEditorBuilder ( string  materialName)

Creates a NXOpen.Display.IrayPlusMaterialEditorBuilder

Created in NX11.0.0

License requirements: studio_render ("UG STUDIO RENDER")

Parameters
materialName
Returns
unsafe NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder NXOpen.ViewCollection.CreateIrayPlusSimpleMaterialEditorBuilder ( )

Creates a NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

Returns
unsafe NXOpen.Display.IRayPlusStudioEditorBuilder NXOpen.ViewCollection.CreateIrayPlusStudioEditorBuilder ( )

Creates a NXOpen.Display.IRayPlusStudioEditorBuilder

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

Returns
unsafe NXOpen.Display.LightBuilder NXOpen.ViewCollection.CreateLightBuilder ( NXOpen.Light  light)

Creates a NXOpen.Display.LightBuilder

Created in NX5.0.0

License requirements: None.

Parameters
lightlight for which data will be modified
Returns
unsafe NXOpen.Display.Lighting NXOpen.ViewCollection.CreateLighting ( NXOpen.View  view)

Creates a NXOpen.Display.Lighting

Created in NX5.0.0

License requirements: None.

Parameters
viewview to which lighting data will be associated
Returns
unsafe NXOpen.Display.NonProportionalZoom NXOpen.ViewCollection.CreateNonProportionalZoom ( )

Creates a NXOpen.Display.NonProportionalZoom

Created in NX7.0.0

License requirements: studio_analyze ("STUDIO ANALYZE")

Returns
unsafe NXOpen.Display.RayTracedStudioBuilder NXOpen.ViewCollection.CreateRayTracedStudioBuilder ( )

Creates a NXOpen.Display.RayTracedStudioBuilder

Created in NX9.0.0

License requirements: None.

Returns
unsafe NXOpen.Display.RayTracedStudioEditorBuilder NXOpen.ViewCollection.CreateRayTracedStudioEditorBuilder ( )

Creates a NXOpen.Display.RayTracedStudioEditorBuilder

Created in NX9.0.0

License requirements: None.

Returns
unsafe 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
viewview to which reflection data will be associated
makeReferencedObjectstrue if referenced image object is to be created
Returns
unsafe NXOpen.Display.SaveImageFileBrowserBuilder NXOpen.ViewCollection.CreateSaveImageFileBrowserBuilder ( )

Creates a NXOpen.Display.SaveImageFileBrowserBuilder

Created in NX9.0.0

License requirements: None.

Returns
unsafe 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
viewview to which scene data will be associated
makeReferencedObjectstrue if scene objects are to be created
Returns
unsafe NXOpen.Display.Shadows NXOpen.ViewCollection.CreateShadows ( NXOpen.View  view)

Creates a NXOpen.Display.Shadows

Created in NX7.5.3

License requirements: None.

Parameters
viewview to which shadows data will be associated
Returns
unsafe 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
viewview to which stage data will be associated
makeReferencedObjectstrue if first wall's image object is to be created
Returns
unsafe NXOpen.Display.StudioImageCaptureBuilder NXOpen.ViewCollection.CreateStudioImageCaptureBuilder ( )

Creates a NXOpen.Display.StudioImageCaptureBuilder

Created in NX6.0.4

License requirements: None.

Returns
unsafe 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
viewview to which stage data will be associated
wallTypewhere the wall sits in the Display.Stage
Returns
override int NXOpen.ViewCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe NXOpen.View NXOpen.ViewCollection.FindObject ( string  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.

Created in NX3.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier of the view to be found
Returns
View with this identifier
unsafe 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.

unsafe NXOpen.View [] NXOpen.ViewCollection.GetActiveViews ( )

Returns the active views in the view collection.

Created in NX3.0.0

License requirements: None.

Returns
List of active views
unsafe string [] NXOpen.ViewCollection.GetCustomViews ( )

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

Created in NX3.0.0

License requirements: None.

Returns
List of custom view names
unsafe NXOpen.View [] NXOpen.ViewCollection.GetDisclosedModelViews ( )

Get disclosed model views in the given part.

Created in NX11.0.1

License requirements: None.

Returns
unsafe NXOpen.View [] NXOpen.ViewCollection.GetDisclosedModelViewsAndPurposes ( out string[]  disclosurePurposes)

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

Created in NX11.0.1

License requirements: None.

Returns
Parameters
disclosurePurposes
unsafe bool NXOpen.ViewCollection.IsWorkViewExpanded ( )

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

Created in NX4.0.0

License requirements: None.

Returns
true if the work view is expanded
unsafe void NXOpen.ViewCollection.Refresh ( )

Refreshes all the views in the current layout

Created in NX3.0.0

License requirements: None.

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

unsafe void NXOpen.ViewCollection.Save ( )

Saves current view.

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.View NXOpen.ViewCollection.SaveAs ( NXOpen.View  selectedView,
string  newViewName,
bool  copyViewModifications,
bool  moveViewDependencies 
)

Saves a view with user specified name.

Created in NX3.0.0

License requirements: None.

Parameters
selectedViewSelected view
newViewNameSelected name of the view
copyViewModificationsTrue if view modifications to be copied
moveViewDependenciesTrue if view dependencies to be moved
Returns
Newly created view
unsafe NXOpen.View NXOpen.ViewCollection.SaveAsPreservingCase ( NXOpen.View  selectedView,
string  newViewName,
bool  copyViewModifications,
bool  moveViewDependencies 
)

Preserve case for user defined view names.

Created in NX8.0.0

License requirements: None.

Parameters
selectedViewSelected view
newViewNameSelected name of the view
copyViewModificationsTrue if view modifications to be copied
moveViewDependenciesTrue if view dependencies to be moved
Returns
Newly created view
NXOpen.View [] NXOpen.ViewCollection.ToArray ( )

Returns an array of NXOpen.View objects.

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

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

Property Documentation

Tag NXOpen.ViewCollection.Tag
get

Returns the tag of this object.

unsafe NXOpen.View NXOpen.ViewCollection.WorkView
get

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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.