AllAroundVisionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AllAroundVisionBuilder Class

class `NXOpen.Features.VehicleDesign.``AllAroundVisionBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  A `NXOpen.Features.VehicleDesign.AllAroundVisionBuilder` used to create or edit a vehicle design `NXOpen.Features.VehicleDesign.AllAroundVision` feature.

  To create a new instance of this class, use `NXOpen.Features.VehicleDesignCollection.CreateAllAroundVisionBuilder()`

  Default values.

  Property | Value
  --- | ---
  CreateIntersectionGeometry | 0
  UseFrontHeadRests | 0
  UseRearHeadRests | 0
  UseWireFrameOnly | 0
  VisionAreaRadius.Value | 0 (millimeters part), 0 (inches part)
  WindowType | Face

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
CarGeometry | Returns the faces representing the car geometry to use as obstructing elements.
CreateIntersectionGeometry | Returns or sets the indication if the intersection geometry should be created.
DistanceTolerance | Returns or sets the distance tolerance.
FrontHeadRestGeometry | Returns the faces representing the front head rest geometry to use as obstructing elements.
ObstructedColor | Returns or sets the color of the obstructed area.
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
RearHeadRestGeometry | Returns the faces representing the rear head rest geometry to use as obstructing elements.
SeatReferencePoint | Returns or sets the seat reference point(SgRP).
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Translucency | Returns or sets the translucency of the vision area.
Type | Returns or sets the type of obstructing geometry being supplied.
UseFrontHeadRests | Returns or sets the indication if the front head rests geometry should be used.
UseRearHeadRests | Returns or sets the indication if rear head rests geometry should be used.
UseWireFrameOnly | Returns or sets the indication if only wire frame should be used.
VisibleColor | Returns or sets the color of the visible area.
VisionAreaRadius | Returns the radius of a circle definiing the vision area.
WindowCurveGeometry | Returns the curves representing the window geometry to use as non-obstructing elements.
WindowFaceGeometry | Returns the faces representing the window geometry to use as non-obstructing elements.
WindowType | Returns or sets the type of geometry used to define the window.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreatePointWithBaseDataSGRPExpression | Create a point according to Base Data SGRP expressions
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.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

AllAroundVisionBuilderTypes Enumeration | Used to indicate the type of obstructing geometry to use.
AllAroundVisionBuilderWindowTypes Enumeration | Used to indicate the type of geometry used to define the window.

# Property Detail

## CarGeometry

`AllAroundVisionBuilder.``CarGeometry`

  Returns the faces representing the car geometry to use as obstructing elements.

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

  Getter Method

  Signature `CarGeometry`

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

  New in version NX8.5.0.

  License requirements: None.

## CreateIntersectionGeometry

`AllAroundVisionBuilder.``CreateIntersectionGeometry`

  Returns or sets the indication if the intersection geometry should be created.

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

  Getter Method

  Signature `CreateIntersectionGeometry`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateIntersectionGeometry`

  Parameters: | createIntersectionGeometry (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## DistanceTolerance

`AllAroundVisionBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## FrontHeadRestGeometry

`AllAroundVisionBuilder.``FrontHeadRestGeometry`

  Returns the faces representing the front head rest geometry to use as obstructing elements.

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

  Getter Method

  Signature `FrontHeadRestGeometry`

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

  New in version NX8.5.0.

  License requirements: None.

## ObstructedColor

`AllAroundVisionBuilder.``ObstructedColor`

  Returns or sets the color of the obstructed area.

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

  Getter Method

  Signature `ObstructedColor`

  Returns: |
  Return type: | Id

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ObstructedColor`

  Parameters: | obstructedColor (Id) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## RearHeadRestGeometry

`AllAroundVisionBuilder.``RearHeadRestGeometry`

  Returns the faces representing the rear head rest geometry to use as obstructing elements.

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

  Getter Method

  Signature `RearHeadRestGeometry`

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

  New in version NX8.5.0.

  License requirements: None.

## SeatReferencePoint

`AllAroundVisionBuilder.``SeatReferencePoint`

  Returns or sets the seat reference point(SgRP).

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

  Getter Method

  Signature `SeatReferencePoint`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SeatReferencePoint`

  Parameters: | seatReferencePoint (`NXOpen.Point`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## Translucency

`AllAroundVisionBuilder.``Translucency`

  Returns or sets the translucency of the vision area.

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

  Getter Method

  Signature `Translucency`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Translucency`

  Parameters: | translucency (int) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## Type

`AllAroundVisionBuilder.``Type`

  Returns or sets the type of obstructing geometry being supplied.

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

  Getter Method

  Signature `Type`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.VehicleDesign.AllAroundVisionBuilderTypes`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## UseFrontHeadRests

`AllAroundVisionBuilder.``UseFrontHeadRests`

  Returns or sets the indication if the front head rests geometry should be used.

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

  Getter Method

  Signature `UseFrontHeadRests`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseFrontHeadRests`

  Parameters: | useFrontHeadRests (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## UseRearHeadRests

`AllAroundVisionBuilder.``UseRearHeadRests`

  Returns or sets the indication if rear head rests geometry should be used.

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

  Getter Method

  Signature `UseRearHeadRests`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseRearHeadRests`

  Parameters: | useRearHeadRests (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## UseWireFrameOnly

`AllAroundVisionBuilder.``UseWireFrameOnly`

  Returns or sets the indication if only wire frame should be used.

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

  Getter Method

  Signature `UseWireFrameOnly`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseWireFrameOnly`

  Parameters: | useWireFrameOnly (bool) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## VisibleColor

`AllAroundVisionBuilder.``VisibleColor`

  Returns or sets the color of the visible area.

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

  Getter Method

  Signature `VisibleColor`

  Returns: |
  Return type: | Id

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `VisibleColor`

  Parameters: | visibleColor (Id) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## VisionAreaRadius

`AllAroundVisionBuilder.``VisionAreaRadius`

  Returns the radius of a circle definiing the vision area.

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

  Getter Method

  Signature `VisionAreaRadius`

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

  New in version NX8.5.0.

  License requirements: None.

## WindowCurveGeometry

`AllAroundVisionBuilder.``WindowCurveGeometry`

  Returns the curves representing the window geometry to use as non-obstructing elements.

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

  Getter Method

  Signature `WindowCurveGeometry`

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

  New in version NX8.5.0.

  License requirements: None.

## WindowFaceGeometry

`AllAroundVisionBuilder.``WindowFaceGeometry`

  Returns the faces representing the window geometry to use as non-obstructing elements.

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

  Getter Method

  Signature `WindowFaceGeometry`

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

  New in version NX8.5.0.

  License requirements: None.

## WindowType

`AllAroundVisionBuilder.``WindowType`

  Returns or sets the type of geometry used to define the window.

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

  Getter Method

  Signature `WindowType`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `WindowType`

  Parameters: | windowType (`NXOpen.Features.VehicleDesign.AllAroundVisionBuilderWindowTypes`) –

  New in version NX8.5.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

# Method Detail

## CreatePointWithBaseDataSGRPExpression

`AllAroundVisionBuilder.``CreatePointWithBaseDataSGRPExpression`

  Create a point according to Base Data SGRP expressions

  Signature `CreatePointWithBaseDataSGRPExpression()`

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

  New in version NX11.0.1.

  License requirements: None.

## Validate

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