CloseRangeCameraListItemBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CloseRangeCameraListItemBuilder Class

class `NXOpen.Features.VehicleDesign.``CloseRangeCameraListItemBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents the builder to create camera list item used for close range visibility.

  To create a new instance of this class, use `NXOpen.Features.VehicleDesign.CloseRangeVisibilityBuilder.CreateCameraListItemBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
CameraAxis | Returns or sets the selected axis defining the camera direction.
CameraCsys | Returns or sets the coordinate system specifying the camera position.
CameraFace | Returns the face selections used to identify the camera surface.
CameraFacetBodies | Returns the facet selections used to identify the camera facet bod.
CameraType | Returns or sets the camera definition type used by the close range visibility.
FaceReverse | Returns or sets the indication if the selected camera face surface should be reversed.
HorizontalLength | Returns the expression containing the value for the horizontal legth.
InitialRadius | Returns the expression containing the value for the initial radius.
Tag | Returns the Tag for this object.
UseCamera | Returns or sets the indication if the defined camera will be used for visibility compute.
VerticalLength | Returns the expression containing the value for the vertical legth.
ViewAngle | Returns the expression containing the value for the view angle.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

CloseRangeCameraListItemBuilderTypes Enumeration | This enum represents the camera definition options to define the close range visibility.

# Property Detail

## CameraAxis

`CloseRangeCameraListItemBuilder.``CameraAxis`

  Returns or sets the selected axis defining the camera direction.

  Only valid when the camera type is round.

  `-------------------------------------`

  Getter Method

  Signature `CameraAxis`

  Returns: |
  Return type: | `NXOpen.Axis`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CameraAxis`

  Parameters: | cameraAxis (`NXOpen.Axis`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## CameraCsys

`CloseRangeCameraListItemBuilder.``CameraCsys`

  Returns or sets the coordinate system specifying the camera position.

  Only valid when the camera type is rectangle.

  `-------------------------------------`

  Getter Method

  Signature `CameraCsys`

  Returns: |
  Return type: | `NXOpen.CoordinateSystem`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CameraCsys`

  Parameters: | cameraCsys (`NXOpen.CoordinateSystem`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## CameraFace

`CloseRangeCameraListItemBuilder.``CameraFace`

  Returns the face selections used to identify the camera surface.

  Only valid when the camera type is face.

  `-------------------------------------`

  Getter Method

  Signature `CameraFace`

  Returns: |
  Return type: | `NXOpen.ScCollector`

  New in version NX8.5.0.

  License requirements: None.

## CameraFacetBodies

`CloseRangeCameraListItemBuilder.``CameraFacetBodies`

  Returns the facet selections used to identify the camera facet bod.

  Only valid when the camera type is facet body.

  `-------------------------------------`

  Getter Method

  Signature `CameraFacetBodies`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX11.0.0.

  License requirements: None.

## CameraType

`CloseRangeCameraListItemBuilder.``CameraType`

  Returns or sets the camera definition type used by the close range visibility.

  `-------------------------------------`

  Getter Method

  Signature `CameraType`

  Returns: |
  Return type: | `NXOpen.Features.VehicleDesign.CloseRangeCameraListItemBuilderTypes`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CameraType`

  Parameters: | cameraType (`NXOpen.Features.VehicleDesign.CloseRangeCameraListItemBuilderTypes`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## FaceReverse

`CloseRangeCameraListItemBuilder.``FaceReverse`

  Returns or sets the indication if the selected camera face surface should be reversed.

  Only valid when the camera type is face.

  `-------------------------------------`

  Getter Method

  Signature `FaceReverse`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FaceReverse`

  Parameters: | faceReverse (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## HorizontalLength

`CloseRangeCameraListItemBuilder.``HorizontalLength`

  Returns the expression containing the value for the horizontal legth.

  Only valid when the camera type is rectangle.

  `-------------------------------------`

  Getter Method

  Signature `HorizontalLength`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## InitialRadius

`CloseRangeCameraListItemBuilder.``InitialRadius`

  Returns the expression containing the value for the initial radius.

  Only valid when the camera type is round.

  `-------------------------------------`

  Getter Method

  Signature `InitialRadius`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## UseCamera

`CloseRangeCameraListItemBuilder.``UseCamera`

  Returns or sets the indication if the defined camera will be used for visibility compute.

  `-------------------------------------`

  Getter Method

  Signature `UseCamera`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseCamera`

  Parameters: | useCamera (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## VerticalLength

`CloseRangeCameraListItemBuilder.``VerticalLength`

  Returns the expression containing the value for the vertical legth.

  Only valid when the camera type is rectangle.

  `-------------------------------------`

  Getter Method

  Signature `VerticalLength`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## ViewAngle

`CloseRangeCameraListItemBuilder.``ViewAngle`

  Returns the expression containing the value for the view angle.

  `-------------------------------------`

  Getter Method

  Signature `ViewAngle`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## Validate

`CloseRangeCameraListItemBuilder.``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.