NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::VehicleDesign::VisionPlaneBuilder Class Reference

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

Inheritance diagram for NXOpen::Features::VehicleDesign::VisionPlaneBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CustomVisionAngle { CustomVisionAngleStandard, CustomVisionAngleCustom }
 Represents the vision angle type to define the Vision Plane. More...
 
enum  EnumEyeType { EnumEyeTypeEyeFeature, EnumEyeTypeV1Point, EnumEyeTypeV2Point }
 Represents the eye definition type to define the Vision Plane. More...
 

Public Member Functions

bool AssoToggle ()
 Returns the associative option that determines whether to create feature or not. More...
 
NXOpen::ExpressionBaseDim ()
 Returns the base dim; dimension from left to right. More...
 
NXOpen::ExpressionDriverPlane ()
 Returns the driver side plane inclined angle. More...
 
NXOpen::Features::SelectFeatureEyeFeature ()
 Returns the eye feature; select eec feature when eye type specified. More...
 
NXOpen::Features::VehicleDesign::VisionPlaneBuilder::EnumEyeType EyeType ()
 Returns the eye type to determine which type of v points to be used. More...
 
NXOpen::ExpressionFrontDim ()
 Returns the front dim; dimension here to front. More...
 
NXOpen::ExpressionFrontPlane ()
 Returns the front plane inclined angle. More...
 
NXString LoadingName ()
 Returns the name of the used loading in the Vision Plane. More...
 
bool LowerPlane ()
 Returns the lower plane option that determines whether to create lower plane or not. More...
 
bool MiddlePlane ()
 Returns the middle plane option that determines whether to create middle plane or not. More...
 
NXOpen::ExpressionMidPlane ()
 Returns the middle plane inclined angle; means front side,passenger side and driver side are the same. More...
 
NXOpen::ExpressionPassengerPlane ()
 Returns the passenger side plane inclined angle. More...
 
NXOpen::PointPointV1 ()
 Returns the point v1; select one point when eye type specified. More...
 
NXOpen::PointPointV2 ()
 Returns the point v2; select one point when eye type specified. More...
 
void SetAssoToggle (bool assoToggle)
 Sets the associative option that determines whether to create feature or not. More...
 
void SetEyeType (NXOpen::Features::VehicleDesign::VisionPlaneBuilder::EnumEyeType eyeType)
 Sets the eye type to determine which type of v points to be used. More...
 
void SetLoadingName (const NXString &loadingName)
 Sets the name of the used loading in the Vision Plane. More...
 
void SetLoadingName (const char *loadingName)
 Sets the name of the used loading in the Vision Plane. More...
 
void SetLowerPlane (bool lowerPlane)
 Sets the lower plane option that determines whether to create lower plane or not. More...
 
void SetMiddlePlane (bool middlePlane)
 Sets the middle plane option that determines whether to create middle plane or not. More...
 
void SetPointV1 (NXOpen::Point *pointV1)
 Sets the point v1; select one point when eye type specified. More...
 
void SetPointV2 (NXOpen::Point *pointV2)
 Sets the point v2; select one point when eye type specified. More...
 
void SetUpperPlane (bool upperPlane)
 Sets the upper plane option that determines whether to create upper plane or not. More...
 
void SetUseStandardLoading (bool useStandardLoading)
 Sets the option that determines whether to use the loading specified by standard or not. More...
 
void SetVisionType (NXOpen::Features::VehicleDesign::VisionPlaneBuilder::CustomVisionAngle visionType)
 Sets the vision type; standard or customer defined. More...
 
bool UpperPlane ()
 Returns the upper plane option that determines whether to create upper plane or not. More...
 
bool UseStandardLoading ()
 Returns the option that determines whether to use the loading specified by standard or not. More...
 
NXOpen::Features::VehicleDesign::VisionPlaneBuilder::CustomVisionAngle VisionType ()
 Returns the vision type; standard or customer defined. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX6.0.0.

Member Enumeration Documentation

Represents the vision angle type to define the Vision Plane.

Enumerator
CustomVisionAngleStandard 

standard

CustomVisionAngleCustom 

customized

Represents the eye definition type to define the Vision Plane.

Enumerator
EnumEyeTypeEyeFeature 

eye feature

EnumEyeTypeV1Point 

v1 point

EnumEyeTypeV2Point 

v2 point

Member Function Documentation

bool NXOpen::Features::VehicleDesign::VisionPlaneBuilder::AssoToggle ( )

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


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::BaseDim ( )

Returns the base dim; dimension from left to right.


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::DriverPlane ( )

Returns the driver side plane inclined angle.


Created in NX6.0.0.

License requirements : None

NXOpen::Features::SelectFeature* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::EyeFeature ( )

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


Created in NX6.0.0.

License requirements : None

NXOpen::Features::VehicleDesign::VisionPlaneBuilder::EnumEyeType NXOpen::Features::VehicleDesign::VisionPlaneBuilder::EyeType ( )

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


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::FrontDim ( )

Returns the front dim; dimension here to front.


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::FrontPlane ( )

Returns the front plane inclined angle.


Created in NX6.0.0.

License requirements : None

NXString NXOpen::Features::VehicleDesign::VisionPlaneBuilder::LoadingName ( )

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


Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::VisionPlaneBuilder::LowerPlane ( )

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


Created in NX6.0.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::VisionPlaneBuilder::MiddlePlane ( )

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


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::MidPlane ( )

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


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::PassengerPlane ( )

Returns the passenger side plane inclined angle.


Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::PointV1 ( )

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


Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::Features::VehicleDesign::VisionPlaneBuilder::PointV2 ( )

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


Created in NX6.0.0.

License requirements : None

void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetAssoToggle ( bool  assoToggle)

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


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
assoToggleassotoggle
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetEyeType ( NXOpen::Features::VehicleDesign::VisionPlaneBuilder::EnumEyeType  eyeType)

Sets the eye type to determine which type of v points to be used.


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
eyeTypeeyetype
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetLoadingName ( const NXString loadingName)

Sets the name of the used loading in the Vision Plane.


Created in NX9.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingNameloadingname
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetLoadingName ( const char *  loadingName)

Sets the name of the used loading in the Vision Plane.


Created in NX9.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
loadingNameloadingname
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetLowerPlane ( bool  lowerPlane)

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


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
lowerPlanelowerplane
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetMiddlePlane ( bool  middlePlane)

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


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
middlePlanemiddleplane
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetPointV1 ( NXOpen::Point pointV1)

Sets the point v1; select one point when eye type specified.


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
pointV1pointv1
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetPointV2 ( NXOpen::Point pointV2)

Sets the point v2; select one point when eye type specified.


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
pointV2pointv2
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetUpperPlane ( bool  upperPlane)

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


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
upperPlaneupperplane
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetUseStandardLoading ( bool  useStandardLoading)

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


Created in NX9.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
useStandardLoadingusestandardloading
void NXOpen::Features::VehicleDesign::VisionPlaneBuilder::SetVisionType ( NXOpen::Features::VehicleDesign::VisionPlaneBuilder::CustomVisionAngle  visionType)

Sets the vision type; standard or customer defined.


Created in NX6.0.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
visionTypevisiontype
bool NXOpen::Features::VehicleDesign::VisionPlaneBuilder::UpperPlane ( )

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


Created in NX6.0.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::VisionPlaneBuilder::UseStandardLoading ( )

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


Created in NX9.0.0.

License requirements : None

NXOpen::Features::VehicleDesign::VisionPlaneBuilder::CustomVisionAngle NXOpen::Features::VehicleDesign::VisionPlaneBuilder::VisionType ( )

Returns the vision type; standard or customer defined.


Created in NX6.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.