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

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

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

Public Types

enum  Types { TypesPillars, TypesWindows }
 Used to indicate the type of obstructing geometry to use. More...
 
enum  WindowTypes { WindowTypesFace, WindowTypesCurve }
 Used to indicate the type of geometry used to define the window. More...
 

Public Member Functions

NXOpen::ScCollectorCarGeometry ()
 Returns the faces representing the car geometry to use as obstructing elements. More...
 
bool CreateIntersectionGeometry ()
 Returns the indication if the intersection geometry should be created. More...
 
NXOpen::PointCreatePointWithBaseDataSGRPExpression ()
 Create a point according to Base Data SGRP expressions. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
NXOpen::ScCollectorFrontHeadRestGeometry ()
 Returns the faces representing the front head rest geometry to use as obstructing elements. More...
 
NXOpen::NXColorObstructedColor ()
 Returns the color of the obstructed area. More...
 
NXOpen::ScCollectorRearHeadRestGeometry ()
 Returns the faces representing the rear head rest geometry to use as obstructing elements. More...
 
NXOpen::PointSeatReferencePoint ()
 Returns the seat reference point(SgRP). More...
 
void SetCreateIntersectionGeometry (bool createIntersectionGeometry)
 Sets the indication if the intersection geometry should be created. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetObstructedColor (NXOpen::NXColor *obstructedColor)
 Sets the color of the obstructed area. More...
 
void SetSeatReferencePoint (NXOpen::Point *seatReferencePoint)
 Sets the seat reference point(SgRP). More...
 
void SetTranslucency (int translucency)
 Sets the translucency of the vision area. More...
 
void SetType (NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::Types type)
 Sets the type of obstructing geometry being supplied. More...
 
void SetUseFrontHeadRests (bool useFrontHeadRests)
 Sets the indication if the front head rests geometry should be used. More...
 
void SetUseRearHeadRests (bool useRearHeadRests)
 Sets the indication if rear head rests geometry should be used. More...
 
void SetUseWireFrameOnly (bool useWireFrameOnly)
 Sets the indication if only wire frame should be used. More...
 
void SetVisibleColor (NXOpen::NXColor *visibleColor)
 Sets the color of the visible area. More...
 
void SetWindowType (NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowTypes windowType)
 Sets the type of geometry used to define the window. More...
 
int Translucency ()
 Returns the translucency of the vision area. More...
 
NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::Types Type ()
 Returns the type of obstructing geometry being supplied. More...
 
bool UseFrontHeadRests ()
 Returns the indication if the front head rests geometry should be used. More...
 
bool UseRearHeadRests ()
 Returns the indication if rear head rests geometry should be used. More...
 
bool UseWireFrameOnly ()
 Returns the indication if only wire frame should be used. More...
 
NXOpen::NXColorVisibleColor ()
 Returns the color of the visible area. More...
 
NXOpen::ExpressionVisionAreaRadius ()
 Returns the radius of a circle definiing the vision area. More...
 
NXOpen::SectionWindowCurveGeometry ()
 Returns the curves representing the window geometry to use as non-obstructing elements. More...
 
NXOpen::ScCollectorWindowFaceGeometry ()
 Returns the faces representing the window geometry to use as non-obstructing elements. More...
 
NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowTypes WindowType ()
 Returns the type of geometry used to define the window. 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

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


Created in NX8.5.0.

Member Enumeration Documentation

Used to indicate the type of obstructing geometry to use.

Enumerator
TypesPillars 

Pillars as obstructing geometry.

TypesWindows 

Windows as non-obstructing geometry.

Used to indicate the type of geometry used to define the window.

Enumerator
WindowTypesFace 

Face Object for Windows.

WindowTypesCurve 

Curve Object for Windows.

Member Function Documentation

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::CarGeometry ( )

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


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::CreateIntersectionGeometry ( )

Returns the indication if the intersection geometry should be created.


Created in NX8.5.0.

License requirements : None

NXOpen::Point* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::CreatePointWithBaseDataSGRPExpression ( )

Create a point according to Base Data SGRP expressions.

Returns

Created in NX11.0.1.

License requirements : None
double NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::DistanceTolerance ( )

Returns the distance tolerance.


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::FrontHeadRestGeometry ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::ObstructedColor ( )

Returns the color of the obstructed area.


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::RearHeadRestGeometry ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::Point* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SeatReferencePoint ( )

Returns the seat reference point(SgRP).


Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetCreateIntersectionGeometry ( bool  createIntersectionGeometry)

Sets the indication if the intersection geometry should be created.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
createIntersectionGeometrycreateintersectiongeometry
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetObstructedColor ( NXOpen::NXColor obstructedColor)

Sets the color of the obstructed area.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
obstructedColorobstructedcolor
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetSeatReferencePoint ( NXOpen::Point seatReferencePoint)

Sets the seat reference point(SgRP).


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
seatReferencePointseatreferencepoint
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetTranslucency ( int  translucency)

Sets the translucency of the vision area.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
translucencytranslucency
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetType ( NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::Types  type)

Sets the type of obstructing geometry being supplied.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
typetype
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetUseFrontHeadRests ( bool  useFrontHeadRests)

Sets the indication if the front head rests geometry should be used.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
useFrontHeadRestsusefrontheadrests
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetUseRearHeadRests ( bool  useRearHeadRests)

Sets the indication if rear head rests geometry should be used.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
useRearHeadRestsuserearheadrests
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetUseWireFrameOnly ( bool  useWireFrameOnly)

Sets the indication if only wire frame should be used.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
useWireFrameOnlyusewireframeonly
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetVisibleColor ( NXOpen::NXColor visibleColor)

Sets the color of the visible area.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
visibleColorvisiblecolor
void NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::SetWindowType ( NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowTypes  windowType)

Sets the type of geometry used to define the window.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
windowTypewindowtype
int NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::Translucency ( )

Returns the translucency of the vision area.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::Types NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::Type ( )

Returns the type of obstructing geometry being supplied.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::UseFrontHeadRests ( )

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


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::UseRearHeadRests ( )

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


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::UseWireFrameOnly ( )

Returns the indication if only wire frame should be used.


Created in NX8.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::VisibleColor ( )

Returns the color of the visible area.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::VisionAreaRadius ( )

Returns the radius of a circle definiing the vision area.


Created in NX8.5.0.

License requirements : None

NXOpen::Section* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowCurveGeometry ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowFaceGeometry ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowTypes NXOpen::Features::VehicleDesign::AllAroundVisionBuilder::WindowType ( )

Returns the type of geometry used to define the window.


Created in NX8.5.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.