CameraCollection Class

class NXOpen.Display.CameraCollection

Bases: object

Represents a collection cameras

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

New in version NX5.0.0.

Methods

Method Description
CreateCameraBuilder Creates a NXOpen.Display.CameraBuilder object if camera is None.
FindObject Finds the NXOpen.Display.Camera with the given identifier as recorded in a journal.

Method Detail

CreateCameraBuilder

CameraCollection.CreateCameraBuilder

Overloaded method CreateCameraBuilder

  • CreateCameraBuilder(camera)
  • CreateCameraBuilder(camera, applyCameraToView)
  • CreateCameraBuilder(view, layout, camera)
  • CreateCameraBuilder(view, layout, camera, applyCameraToView)

-------------------------------------

Creates a NXOpen.Display.CameraBuilder object if camera is None. Otherwise, a Camera object will be edited. If camera is not None and the camera is associated with a view other than the work view, then the camera will be applied to the current work view.

Signature CreateCameraBuilder(camera)

Parameters:camera (NXOpen.Display.Camera) – If camera is not None, then this object will be edited
Returns:return camera builder
Return type:NXOpen.Display.CameraBuilder

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Creates a NXOpen.Display.CameraBuilder object if camera is None. Otherwise, a Camera object will be edited. If camera is not None 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.

Signature CreateCameraBuilder(camera, applyCameraToView)

Parameters:
  • camera (NXOpen.Display.Camera) – If camera is not None, then this object will be edited
  • applyCameraToView (bool) – true if the camera is to be applied to its view
Returns:

return camera builder
Return type:

NXOpen.Display.CameraBuilder

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Creates a NXOpen.Display.CameraBuilder object if camera is None. Otherwise, a Camera object will be edited. Initializes the camera with data from the view in the layout. If camera is not None and the camera is associated with a view other than the work view, then the camera will be applied to the current work view.

Signature CreateCameraBuilder(view, layout, camera)

Parameters:
Returns:

return camera builder
Return type:

NXOpen.Display.CameraBuilder

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Creates a NXOpen.Display.CameraBuilder object if camera is None. Otherwise, a Camera object will be edited. Initializes the camera with data from the view in the layout. If camera is not None 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.

Signature CreateCameraBuilder(view, layout, camera, applyCameraToView)

Parameters:
  • view (NXOpen.View) – Use this view’s data to initialize the camera
  • layout (NXOpen.Layout) – Layout of the view
  • camera (NXOpen.Display.Camera) – If camera is not None, then this object will be edited
  • applyCameraToView (bool) – true if the camera is to be applied to its view
Returns:

return camera builder
Return type:

NXOpen.Display.CameraBuilder

New in version NX11.0.0.

License requirements: None.

-------------------------------------

FindObject

CameraCollection.FindObject

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.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Identifier to be found
Returns:Camera found
Return type:NXOpen.Display.Camera

New in version NX5.0.0.

License requirements: None.