WindshieldDatumBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# WindshieldDatumBuilder Class

class `NXOpen.Features.VehicleDesign.``WindshieldDatumBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.VehicleDesign.WindshieldDatum` builder used to create or edit a Windshield Datum.

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

  Default values.

  Property | Value
  --- | ---
  AssoToggle | 1
  BottomAngle.Value | 5
  EyeType | EyeFeature
  HorizontalAngle.Value | 17
  RayLength.Value | 3000 (millimeters part), 0 (inches part)
  ShowPoints | 1
  ShowRays | 1
  TopAngle.Value | 7
  UseStandardLoading | 1
  VisionType | Standard

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AssoToggle | Returns or sets the associative option that determines whether to create feature or not.
BottomAngle | Returns the bottom inclined angle.
EyeFeature | Returns the eye feature; select eec feature when eye type specified.
EyeType | Returns or sets the eye type to determine which type of v points to be used.
HorizontalAngle | Returns the horizontal inclined angle.
LoadingName | Returns or sets the name of the used loading in the Windshield Datum.
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
PointV1 | Returns or sets the point v1; select one point when eye type specified.
PointV2 | Returns or sets the point v2; select one point when eye type specified.
RayLength | Returns the ray length.
SelectWindshield | Returns the windshield collector which the v points will be projected onto.
ShowPoints | Returns or sets the show points to determine whether to create points or not.
ShowRays | Returns or sets the show rays to determine whether to create ray lines or not.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TopAngle | Returns the top inclined angle.
UseStandardLoading | Returns or sets the option that determines whether to use the loading specified by standard or not.
VisionType | Returns or sets the vision type; standard or customer defined.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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

WindshieldDatumBuilderCustomVisionAngle Enumeration | Represents the vision angle type to define the Windshield Datum.
WindshieldDatumBuilderEnumEyeType Enumeration | Represents the eye definition type to define the Windshield Datum.

# Property Detail

## AssoToggle

`WindshieldDatumBuilder.``AssoToggle`

  Returns or sets the associative option that determines whether to create feature or not.

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

  Getter Method

  Signature `AssoToggle`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AssoToggle`

  Parameters: | assoToggle (bool) –

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## BottomAngle

`WindshieldDatumBuilder.``BottomAngle`

  Returns the bottom inclined angle.

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

  Getter Method

  Signature `BottomAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## EyeFeature

`WindshieldDatumBuilder.``EyeFeature`

  Returns the eye feature; select eec feature when eye type specified.

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

  Getter Method

  Signature `EyeFeature`

  Returns: |
  Return type: | `NXOpen.Features.SelectFeature`

  New in version NX6.0.0.

  License requirements: None.

## EyeType

`WindshieldDatumBuilder.``EyeType`

  Returns or sets the eye type to determine which type of v points to be used.

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

  Getter Method

  Signature `EyeType`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EyeType`

  Parameters: | eyeType (`NXOpen.Features.VehicleDesign.WindshieldDatumBuilderEnumEyeType`) –

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## HorizontalAngle

`WindshieldDatumBuilder.``HorizontalAngle`

  Returns the horizontal inclined angle.

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

  Getter Method

  Signature `HorizontalAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## LoadingName

`WindshieldDatumBuilder.``LoadingName`

  Returns or sets the name of the used loading in the Windshield Datum.

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

  Getter Method

  Signature `LoadingName`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LoadingName`

  Parameters: | loadingName (str) –

  New in version NX9.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## PointV1

`WindshieldDatumBuilder.``PointV1`

  Returns or sets the point v1; select one point when eye type specified.

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

  Getter Method

  Signature `PointV1`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointV1`

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

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## PointV2

`WindshieldDatumBuilder.``PointV2`

  Returns or sets the point v2; select one point when eye type specified.

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

  Getter Method

  Signature `PointV2`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointV2`

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

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## RayLength

`WindshieldDatumBuilder.``RayLength`

  Returns the ray length.

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

  Getter Method

  Signature `RayLength`

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

  New in version NX6.0.0.

  License requirements: None.

## SelectWindshield

`WindshieldDatumBuilder.``SelectWindshield`

  Returns the windshield collector which the v points will be projected onto.

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

  Getter Method

  Signature `SelectWindshield`

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

  New in version NX6.0.0.

  License requirements: None.

## ShowPoints

`WindshieldDatumBuilder.``ShowPoints`

  Returns or sets the show points to determine whether to create points or not.

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

  Getter Method

  Signature `ShowPoints`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowPoints`

  Parameters: | showPoints (bool) –

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## ShowRays

`WindshieldDatumBuilder.``ShowRays`

  Returns or sets the show rays to determine whether to create ray lines or not.

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

  Getter Method

  Signature `ShowRays`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowRays`

  Parameters: | showRays (bool) –

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## TopAngle

`WindshieldDatumBuilder.``TopAngle`

  Returns the top inclined angle.

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

  Getter Method

  Signature `TopAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## UseStandardLoading

`WindshieldDatumBuilder.``UseStandardLoading`

  Returns or sets the option that determines whether to use the loading specified by standard or not.

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

  Getter Method

  Signature `UseStandardLoading`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseStandardLoading`

  Parameters: | useStandardLoading (bool) –

  New in version NX9.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

## VisionType

`WindshieldDatumBuilder.``VisionType`

  Returns or sets the vision type; standard or customer defined.

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

  Getter Method

  Signature `VisionType`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `VisionType`

  Parameters: | visionType (`NXOpen.Features.VehicleDesign.WindshieldDatumBuilderCustomVisionAngle`) –

  New in version NX6.0.0.

  License requirements: nx_general_packaging (“NX General Packaging”)

# Method Detail

## Validate

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