NX Open C++ Reference Guide
|
Represents a collection cameras
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX5.0.0.
More...
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::CameraBuilder * | CreateCameraBuilder (NXOpen::Display::Camera *camera) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL. More... | |
NXOpen::Display::CameraBuilder * | CreateCameraBuilder (NXOpen::Display::Camera *camera, bool applyCameraToView) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL. More... | |
NXOpen::Display::CameraBuilder * | CreateCameraBuilder (NXOpen::View *view, NXOpen::Layout *layout, NXOpen::Display::Camera *camera) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL. More... | |
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 NULL. More... | |
iterator | end () |
Returns an iterator addressing one past the last element. More... | |
NXOpen::Display::Camera * | FindObject (const NXString &journalIdentifier) |
Finds the NXOpen::Display::Camera with the given identifier as recorded in a journal. More... | |
NXOpen::Display::Camera * | FindObject (const char *journalIdentifier) |
Finds the NXOpen::Display::Camera with the given identifier as recorded in a journal. More... | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a collection cameras
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX5.0.0.
iterator NXOpen::Display::CameraCollection::begin | ( | ) |
Returns an iterator addressing the first element.
NXOpen::Display::CameraBuilder* NXOpen::Display::CameraCollection::CreateCameraBuilder | ( | NXOpen::Display::Camera * | camera | ) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL.
Otherwise, a Camera object will be edited. If camera is not NULL and the camera is associated with a view other than the work view, then the camera will be applied to the current work view.
camera | If camera is not NULL, then this object will be edited |
NXOpen::Display::CameraBuilder* NXOpen::Display::CameraCollection::CreateCameraBuilder | ( | NXOpen::Display::Camera * | camera, |
bool | applyCameraToView | ||
) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL.
Otherwise, a Camera object will be edited. If camera is not NULL 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.
camera | If camera is not NULL, then this object will be edited |
applyCameraToView | true if the camera is to be applied to its view |
NXOpen::Display::CameraBuilder* NXOpen::Display::CameraCollection::CreateCameraBuilder | ( | NXOpen::View * | view, |
NXOpen::Layout * | layout, | ||
NXOpen::Display::Camera * | camera | ||
) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL.
Otherwise, a Camera object will be edited. Initializes the camera with data from the view in the layout. If camera is not NULL and the camera is associated with a view other than the work view, then the camera will be applied to the current work view.
view | Use this view's data to initialize the camera |
layout | Layout of the view |
camera | If camera is not NULL, then this object will be edited |
NXOpen::Display::CameraBuilder* NXOpen::Display::CameraCollection::CreateCameraBuilder | ( | NXOpen::View * | view, |
NXOpen::Layout * | layout, | ||
NXOpen::Display::Camera * | camera, | ||
bool | applyCameraToView | ||
) |
Creates a NXOpen::Display::CameraBuilder object if camera is NULL.
Otherwise, a Camera object will be edited. Initializes the camera with data from the view in the layout. If camera is not NULL 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.
view | Use this view's data to initialize the camera |
layout | Layout of the view |
camera | If camera is not NULL, then this object will be edited |
applyCameraToView | true if the camera is to be applied to its view |
iterator NXOpen::Display::CameraCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
NXOpen::Display::Camera* NXOpen::Display::CameraCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
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.
journalIdentifier | Identifier to be found |
NXOpen::Display::Camera* NXOpen::Display::CameraCollection::FindObject | ( | const char * | journalIdentifier | ) |
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.
journalIdentifier | Identifier to be found |
tag_t NXOpen::Display::CameraCollection::Tag | ( | ) | const |
Returns the tag of this object.