NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Display.CameraCollection Class Reference

Represents a collection cameras More...

Inheritance diagram for NXOpen.Display.CameraCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe NXOpen.Display.CameraBuilder CreateCameraBuilder (NXOpen.Display.Camera camera)
 Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic). More...
 
unsafe NXOpen.Display.CameraBuilder CreateCameraBuilder (NXOpen.Display.Camera camera, bool applyCameraToView)
 Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic). More...
 
unsafe NXOpen.Display.CameraBuilder CreateCameraBuilder (NXOpen.View view, NXOpen.Layout layout, NXOpen.Display.Camera camera)
 Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic). More...
 
unsafe NXOpen.Display.CameraBuilder CreateCameraBuilder (NXOpen.View view, NXOpen.Layout layout, NXOpen.Display.Camera camera, bool applyCameraToView)
 Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic). More...
 
unsafe NXOpen.Display.Camera FindObject (string journalIdentifier)
 Finds the NXOpen.Display.Camera with the given identifier as recorded in a journal. More...
 
NXOpen.Display.Camera[] ToArray ()
 Returns an array of NXOpen.Display.Camera objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection cameras

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

Created in NX5.0.0

Member Function Documentation

unsafe NXOpen.Display.CameraBuilder NXOpen.Display.CameraCollection.CreateCameraBuilder ( NXOpen.Display.Camera  camera)
inline

Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic).

Otherwise, a Camera object will be edited. If camera is not a null reference (Nothing in Visual Basic) and the camera is associated with a view other than the work view, then the camera will be applied to the current work view.

Created in NX5.0.0

License requirements: None.

Parameters
cameraIf camera is not a null reference (Nothing in Visual Basic), then this object will be edited
Returns
return camera builder
unsafe NXOpen.Display.CameraBuilder NXOpen.Display.CameraCollection.CreateCameraBuilder ( NXOpen.Display.Camera  camera,
bool  applyCameraToView 
)
inline

Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic).

Otherwise, a Camera object will be edited. If camera is not a null reference (Nothing in Visual Basic) and the camera is associated with a view other than the work view, then the camera will be applied to the current work view if and only if applyCameraToView is true.

Created in NX11.0.0

License requirements: None.

Parameters
cameraIf camera is not a null reference (Nothing in Visual Basic), then this object will be edited
applyCameraToViewtrue if the camera is to be applied to its view
Returns
return camera builder
unsafe NXOpen.Display.CameraBuilder NXOpen.Display.CameraCollection.CreateCameraBuilder ( NXOpen.View  view,
NXOpen.Layout  layout,
NXOpen.Display.Camera  camera 
)
inline

Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic).

Otherwise, a Camera object will be edited. Initializes the camera with data from the view in the layout. If camera is not a null reference (Nothing in Visual Basic) and the camera is associated with a view other than the work view, then the camera will be applied to the current work view.

Created in NX6.0.0

License requirements: None.

Parameters
viewUse this view's data to initialize the camera
layoutLayout of the view
cameraIf camera is not a null reference (Nothing in Visual Basic), then this object will be edited
Returns
return camera builder
unsafe NXOpen.Display.CameraBuilder NXOpen.Display.CameraCollection.CreateCameraBuilder ( NXOpen.View  view,
NXOpen.Layout  layout,
NXOpen.Display.Camera  camera,
bool  applyCameraToView 
)
inline

Creates a NXOpen.Display.CameraBuilder object if camera is a null reference (Nothing in Visual Basic).

Otherwise, a Camera object will be edited. Initializes the camera with data from the view in the layout. If camera is not a null reference (Nothing in Visual Basic) and the camera is associated with a view other than the work view, then the camera will be applied to the current work view if and only if applyCameraToView is truel.

Created in NX11.0.0

License requirements: None.

Parameters
viewUse this view's data to initialize the camera
layoutLayout of the view
cameraIf camera is not a null reference (Nothing in Visual Basic), then this object will be edited
applyCameraToViewtrue if the camera is to be applied to its view
Returns
return camera builder
override int NXOpen.Display.CameraCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Display.Camera NXOpen.Display.CameraCollection.FindObject ( string  journalIdentifier)
inline

Finds the NXOpen.Display.Camera 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 NX5.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier to be found
Returns
Camera found
NXOpen.Display.Camera [] NXOpen.Display.CameraCollection.ToArray ( )
inline

Returns an array of NXOpen.Display.Camera objects.

Property Documentation

Tag NXOpen.Display.CameraCollection.Tag
get

Returns the tag of this object.


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