CameraBuilder Class¶
-
class
NXOpen.Display.CameraBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.CameraBuilderCameras are not supported in KF.
New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| ApertureType | Returns or sets the aperture |
| BackClippingDistance | Returns or sets the back clipping distance |
| CameraMatrix | Returns or sets the camera rotation matrix |
| CameraName | Returns or sets the camera name as a TEXT string. |
| CameraNameChar | Returns or sets the camera name as a char string |
| CameraPosition | Returns or sets the coordinates of the camera point |
| DepthOfFieldToggle | Returns or sets the depth of field toggle |
| FieldOfViewAngle | Returns or sets the field of view angle |
| FieldOfViewMeasured | Returns or sets the field of view measured |
| FocalDistance | Returns or sets the focal distance |
| FrontClippingDistance | Returns or sets the front clipping distance |
| HiddenLensFlareToggle | Returns or sets the hidden lens flare toggle |
| LensAngleType | Returns or sets the lens angle |
| LensFlareIntensity | Returns or sets the lens flare intensity |
| LensFlareToggle | Returns or sets the lens flare toggle |
| LensFlareType | Returns or sets the lens flare type |
| Magnification | Returns or sets the magnification |
| PerspectiveDistance | Returns or sets the perspective distance |
| StockLensType | Returns or sets the stock lens type |
| Tag | Returns the Tag for this object. |
| TargetMatrix | Returns or sets the target point rotation matrix |
| TargetPosition | Returns or sets the coordinates of the target point |
| Type | Returns or sets the camera type |
| UseTargetPoint | Returns or sets whether to use the target point |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| CameraBuilderAperture Enumeration | Predefined apertures: f2. |
| CameraBuilderFovMeasured Enumeration | either horizontal or vertical measure |
| CameraBuilderLensAngle Enumeration | the way to define the field of view angle |
| CameraBuilderLensFlare Enumeration | Predefined lens flare types: Standard, 35mm, 50mm, 105mm, polygonal, 35mm poly, 50mm poly, 105mm poly, spark, star |
| CameraBuilderStockLens Enumeration | Predefined lenses: 28, 35, 50, 70, 105, 135, 210, 300mm |
| CameraBuilderTypes Enumeration | the camera types |
Property Detail¶
ApertureType¶
-
CameraBuilder.ApertureType¶ Returns or sets the aperture
-------------------------------------Getter Method
Signature
ApertureType()Returns: Return type: NXOpen.Display.CameraBuilderApertureNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ApertureType(apertureType)Parameters: apertureType ( NXOpen.Display.CameraBuilderAperture) –New in version NX5.0.0.
License requirements: None.
BackClippingDistance¶
-
CameraBuilder.BackClippingDistance¶ Returns or sets the back clipping distance
-------------------------------------Getter Method
Signature
BackClippingDistance()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BackClippingDistance(backClippingDistance)Parameters: backClippingDistance (float) – New in version NX5.0.0.
License requirements: None.
CameraMatrix¶
-
CameraBuilder.CameraMatrix¶ Returns or sets the camera rotation matrix
-------------------------------------Getter Method
Signature
CameraMatrix()Returns: Return type: NXOpen.Matrix3x3New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CameraMatrix(cameraMatrix)Parameters: cameraMatrix ( NXOpen.Matrix3x3) –New in version NX5.0.0.
License requirements: None.
CameraName¶
-
CameraBuilder.CameraName¶ Returns or sets the camera name as a TEXT string.
Note that internally the camera name is stored as a char* string. Any characters which cannot be mapped to 8-bit characters will be replaced by # characters.
-------------------------------------Getter Method
Signature
CameraName()Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CameraName(cameraName)Parameters: cameraName (str) – New in version NX5.0.0.
License requirements: None.
CameraNameChar¶
-
CameraBuilder.CameraNameChar¶ Returns or sets the camera name as a char string
-------------------------------------Getter Method
Signature
CameraNameChar()Returns: Return type: str New in version NX5.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
CameraNameChar(cameraName)Parameters: cameraName (str) – New in version NX5.0.1.
License requirements: None.
CameraPosition¶
-
CameraBuilder.CameraPosition¶ Returns or sets the coordinates of the camera point
-------------------------------------Getter Method
Signature
CameraPosition()Returns: Return type: NXOpen.Point3dNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CameraPosition(position)Parameters: position ( NXOpen.Point3d) –New in version NX5.0.0.
License requirements: None.
DepthOfFieldToggle¶
-
CameraBuilder.DepthOfFieldToggle¶ Returns or sets the depth of field toggle
-------------------------------------Getter Method
Signature
DepthOfFieldToggle()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DepthOfFieldToggle(depthOfFieldToggle)Parameters: depthOfFieldToggle (bool) – New in version NX5.0.0.
License requirements: None.
FieldOfViewAngle¶
-
CameraBuilder.FieldOfViewAngle¶ Returns or sets the field of view angle
-------------------------------------Getter Method
Signature
FieldOfViewAngle()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FieldOfViewAngle(fieldOfViewAngle)Parameters: fieldOfViewAngle (float) – New in version NX5.0.0.
License requirements: None.
FieldOfViewMeasured¶
-
CameraBuilder.FieldOfViewMeasured¶ Returns or sets the field of view measured
-------------------------------------Getter Method
Signature
FieldOfViewMeasured()Returns: Return type: NXOpen.Display.CameraBuilderFovMeasuredNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FieldOfViewMeasured(fovMeasuredType)Parameters: fovMeasuredType ( NXOpen.Display.CameraBuilderFovMeasured) –New in version NX5.0.0.
License requirements: None.
FocalDistance¶
-
CameraBuilder.FocalDistance¶ Returns or sets the focal distance
-------------------------------------Getter Method
Signature
FocalDistance()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FocalDistance(focalDistance)Parameters: focalDistance (float) – New in version NX5.0.0.
License requirements: None.
FrontClippingDistance¶
-
CameraBuilder.FrontClippingDistance¶ Returns or sets the front clipping distance
-------------------------------------Getter Method
Signature
FrontClippingDistance()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FrontClippingDistance(frontClippingDistance)Parameters: frontClippingDistance (float) – New in version NX5.0.0.
License requirements: None.
LensAngleType¶
-
CameraBuilder.LensAngleType¶ Returns or sets the lens angle
-------------------------------------Getter Method
Signature
LensAngleType()Returns: Return type: NXOpen.Display.CameraBuilderLensAngleNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LensAngleType(lensAngleType)Parameters: lensAngleType ( NXOpen.Display.CameraBuilderLensAngle) –New in version NX5.0.0.
License requirements: None.
LensFlareIntensity¶
-
CameraBuilder.LensFlareIntensity¶ Returns or sets the lens flare intensity
-------------------------------------Getter Method
Signature
LensFlareIntensity()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LensFlareIntensity(lensFlareIntensity)Parameters: lensFlareIntensity (float) – New in version NX5.0.0.
License requirements: None.
LensFlareToggle¶
-
CameraBuilder.LensFlareToggle¶ Returns or sets the lens flare toggle
-------------------------------------Getter Method
Signature
LensFlareToggle()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LensFlareToggle(lensFlareToggle)Parameters: lensFlareToggle (bool) – New in version NX5.0.0.
License requirements: None.
LensFlareType¶
-
CameraBuilder.LensFlareType¶ Returns or sets the lens flare type
-------------------------------------Getter Method
Signature
LensFlareType()Returns: Return type: NXOpen.Display.CameraBuilderLensFlareNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LensFlareType(lensFlareType)Parameters: lensFlareType ( NXOpen.Display.CameraBuilderLensFlare) –New in version NX5.0.0.
License requirements: None.
Magnification¶
-
CameraBuilder.Magnification¶ Returns or sets the magnification
-------------------------------------Getter Method
Signature
Magnification()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Magnification(magnification)Parameters: magnification (float) – New in version NX5.0.0.
License requirements: None.
PerspectiveDistance¶
-
CameraBuilder.PerspectiveDistance¶ Returns or sets the perspective distance
-------------------------------------Getter Method
Signature
PerspectiveDistance()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PerspectiveDistance(perspectiveDistance)Parameters: perspectiveDistance (float) – New in version NX5.0.0.
License requirements: None.
StockLensType¶
-
CameraBuilder.StockLensType¶ Returns or sets the stock lens type
-------------------------------------Getter Method
Signature
StockLensType()Returns: Return type: NXOpen.Display.CameraBuilderStockLensNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StockLensType(stockLensType)Parameters: stockLensType ( NXOpen.Display.CameraBuilderStockLens) –New in version NX5.0.0.
License requirements: None.
TargetMatrix¶
-
CameraBuilder.TargetMatrix¶ Returns or sets the target point rotation matrix
-------------------------------------Getter Method
Signature
TargetMatrix()Returns: Return type: NXOpen.Matrix3x3New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TargetMatrix(matrix)Parameters: matrix ( NXOpen.Matrix3x3) –New in version NX5.0.0.
License requirements: None.
TargetPosition¶
-
CameraBuilder.TargetPosition¶ Returns or sets the coordinates of the target point
-------------------------------------Getter Method
Signature
TargetPosition()Returns: Return type: NXOpen.Point3dNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TargetPosition(position)Parameters: position ( NXOpen.Point3d) –New in version NX5.0.0.
License requirements: None.
Type¶
-
CameraBuilder.Type¶ Returns or sets the camera type
-------------------------------------Getter Method
Signature
Type()Returns: Return type: NXOpen.Display.CameraBuilderTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(type)Parameters: type ( NXOpen.Display.CameraBuilderTypes) –New in version NX5.0.0.
License requirements: None.
UseTargetPoint¶
-
CameraBuilder.UseTargetPoint¶ Returns or sets whether to use the target point
-------------------------------------Getter Method
Signature
UseTargetPoint()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseTargetPoint(useTargetPoint)Parameters: useTargetPoint (bool) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
CameraBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.