VisionPlaneBuilder Class

class NXOpen.Features.VehicleDesign.VisionPlaneBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.VehicleDesign.VisionPlane builder used to create or edit a Vision Plane.

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

Default values.

Property Value
AssoToggle 1
BaseDim.Value 2000 (millimeters part), 0 (inches part)
DriverPlane.Value 4
EyeType EyeFeature
FrontDim.Value 1000 (millimeters part), 0 (inches part)
FrontPlane.Value 4
LowerPlane 1
MidPlane.Value 1
MiddlePlane 1
PassengerPlane.Value 4
UpperPlane 1
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.
BaseDim Returns the base dim; dimension from left to right.
DriverPlane Returns the driver side plane 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.
FrontDim Returns the front dim; dimension here to front.
FrontPlane Returns the front plane inclined angle.
LoadingName Returns or sets the name of the used loading in the Vision Plane.
LowerPlane Returns or sets the lower plane option that determines whether to create lower plane or not.
MidPlane Returns the middle plane inclined angle; means front side,passenger side and driver side are the same.
MiddlePlane Returns or sets the middle plane option that determines whether to create middle plane or not.
ParentFeatureInternal Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PassengerPlane Returns the passenger side plane inclined angle.
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.
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
UpperPlane Returns or sets the upper plane option that determines whether to create upper plane or not.
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

VisionPlaneBuilderCustomVisionAngle Enumeration Represents the vision angle type to define the Vision Plane.
VisionPlaneBuilderEnumEyeType Enumeration Represents the eye definition type to define the Vision Plane.

Property Detail

AssoToggle

VisionPlaneBuilder.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”)

BaseDim

VisionPlaneBuilder.BaseDim

Returns the base dim; dimension from left to right.

-------------------------------------

Getter Method

Signature BaseDim

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

DriverPlane

VisionPlaneBuilder.DriverPlane

Returns the driver side plane inclined angle.

-------------------------------------

Getter Method

Signature DriverPlane

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

EyeFeature

VisionPlaneBuilder.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

VisionPlaneBuilder.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.VisionPlaneBuilderEnumEyeType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature EyeType

Parameters:eyeType (NXOpen.Features.VehicleDesign.VisionPlaneBuilderEnumEyeType) –

New in version NX6.0.0.

License requirements: nx_general_packaging (“NX General Packaging”)

FrontDim

VisionPlaneBuilder.FrontDim

Returns the front dim; dimension here to front.

-------------------------------------

Getter Method

Signature FrontDim

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

FrontPlane

VisionPlaneBuilder.FrontPlane

Returns the front plane inclined angle.

-------------------------------------

Getter Method

Signature FrontPlane

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

LoadingName

VisionPlaneBuilder.LoadingName

Returns or sets the name of the used loading in the Vision Plane.

-------------------------------------

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”)

LowerPlane

VisionPlaneBuilder.LowerPlane

Returns or sets the lower plane option that determines whether to create lower plane or not.

-------------------------------------

Getter Method

Signature LowerPlane

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LowerPlane

Parameters:lowerPlane (bool) –

New in version NX6.0.0.

License requirements: nx_general_packaging (“NX General Packaging”)

MidPlane

VisionPlaneBuilder.MidPlane

Returns the middle plane inclined angle; means front side,passenger side and driver side are the same.

-------------------------------------

Getter Method

Signature MidPlane

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

MiddlePlane

VisionPlaneBuilder.MiddlePlane

Returns or sets the middle plane option that determines whether to create middle plane or not.

-------------------------------------

Getter Method

Signature MiddlePlane

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MiddlePlane

Parameters:middlePlane (bool) –

New in version NX6.0.0.

License requirements: nx_general_packaging (“NX General Packaging”)

PassengerPlane

VisionPlaneBuilder.PassengerPlane

Returns the passenger side plane inclined angle.

-------------------------------------

Getter Method

Signature PassengerPlane

Returns:
Return type:NXOpen.Expression

New in version NX6.0.0.

License requirements: None.

PointV1

VisionPlaneBuilder.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

VisionPlaneBuilder.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”)

UpperPlane

VisionPlaneBuilder.UpperPlane

Returns or sets the upper plane option that determines whether to create upper plane or not.

-------------------------------------

Getter Method

Signature UpperPlane

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UpperPlane

Parameters:upperPlane (bool) –

New in version NX6.0.0.

License requirements: nx_general_packaging (“NX General Packaging”)

UseStandardLoading

VisionPlaneBuilder.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

VisionPlaneBuilder.VisionType

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

-------------------------------------

Getter Method

Signature VisionType

Returns:
Return type:NXOpen.Features.VehicleDesign.VisionPlaneBuilderCustomVisionAngle

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature VisionType

Parameters:visionType (NXOpen.Features.VehicleDesign.VisionPlaneBuilderCustomVisionAngle) –

New in version NX6.0.0.

License requirements: nx_general_packaging (“NX General Packaging”)

Method Detail

Validate

VisionPlaneBuilder.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.