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

Represents the builder to create camera list item used for close range visibility. More...

Inheritance diagram for NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Types { TypesRound, TypesRectangle, TypesFace }
 This enum represents the camera definition options to define the close range visibility. More...
 

Public Member Functions

NXOpen::AxisCameraAxis ()
 Returns the selected axis defining the camera direction. More...
 
NXOpen::CoordinateSystemCameraCsys ()
 Returns the coordinate system specifying the camera position. More...
 
NXOpen::ScCollectorCameraFace ()
 Returns the face selections used to identify the camera surface. More...
 
NXOpen::SelectNXObjectListCameraFacetBodies ()
 Returns the facet selections used to identify the camera facet bod. More...
 
NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types CameraType ()
 Returns the camera definition type used by the close range visibility. More...
 
bool FaceReverse ()
 Returns the indication if the selected camera face surface should be reversed. More...
 
NXOpen::ExpressionHorizontalLength ()
 Returns the expression containing the value for the horizontal legth. More...
 
NXOpen::ExpressionInitialRadius ()
 Returns the expression containing the value for the initial radius. More...
 
void SetCameraAxis (NXOpen::Axis *cameraAxis)
 Sets the selected axis defining the camera direction. More...
 
void SetCameraCsys (NXOpen::CoordinateSystem *cameraCsys)
 Sets the coordinate system specifying the camera position. More...
 
void SetCameraType (NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types cameraType)
 Sets the camera definition type used by the close range visibility. More...
 
void SetFaceReverse (bool faceReverse)
 Sets the indication if the selected camera face surface should be reversed. More...
 
void SetUseCamera (bool useCamera)
 Sets the indication if the defined camera will be used for visibility compute. More...
 
bool UseCamera ()
 Returns the indication if the defined camera will be used for visibility compute. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::ExpressionVerticalLength ()
 Returns the expression containing the value for the vertical legth. More...
 
NXOpen::ExpressionViewAngle ()
 Returns the expression containing the value for the view angle. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the builder to create camera list item used for close range visibility.


To create a new instance of this class, use NXOpen::Features::VehicleDesign::CloseRangeVisibilityBuilder::CreateCameraListItemBuilder

Created in NX8.5.0.

Member Enumeration Documentation

This enum represents the camera definition options to define the close range visibility.

Enumerator
TypesRound 

Round type.

TypesRectangle 

Rectangle type.

TypesFace 

Face type.

Member Function Documentation

NXOpen::Axis* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::CameraAxis ( )

Returns the selected axis defining the camera direction.

Only valid when the camera type is round.
Created in NX8.5.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::CameraCsys ( )

Returns the coordinate system specifying the camera position.

Only valid when the camera type is rectangle.
Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::CameraFace ( )

Returns the face selections used to identify the camera surface.

Only valid when the camera type is face.
Created in NX8.5.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::CameraFacetBodies ( )

Returns the facet selections used to identify the camera facet bod.

Only valid when the camera type is facet body.
Created in NX11.0.0.

License requirements : None

NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::CameraType ( )

Returns the camera definition type used by the close range visibility.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::FaceReverse ( )

Returns the indication if the selected camera face surface should be reversed.

Only valid when the camera type is face.
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::HorizontalLength ( )

Returns the expression containing the value for the horizontal legth.

Only valid when the camera type is rectangle.
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::InitialRadius ( )

Returns the expression containing the value for the initial radius.

Only valid when the camera type is round.
Created in NX8.5.0.

License requirements : None

void NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::SetCameraAxis ( NXOpen::Axis cameraAxis)

Sets the selected axis defining the camera direction.

Only valid when the camera type is round.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
cameraAxiscameraaxis
void NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::SetCameraCsys ( NXOpen::CoordinateSystem cameraCsys)

Sets the coordinate system specifying the camera position.

Only valid when the camera type is rectangle.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
cameraCsyscameracsys
void NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::SetCameraType ( NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types  cameraType)

Sets the camera definition type used by the close range visibility.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
cameraTypecameratype
void NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::SetFaceReverse ( bool  faceReverse)

Sets the indication if the selected camera face surface should be reversed.

Only valid when the camera type is face.
Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
faceReversefacereverse
void NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::SetUseCamera ( bool  useCamera)

Sets the indication if the defined camera will be used for visibility compute.


Created in NX8.5.0.

License requirements : nx_general_packaging ("NX General Packaging")

Parameters
useCamerausecamera
bool NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::UseCamera ( )

Returns the indication if the defined camera will be used for visibility compute.


Created in NX8.5.0.

License requirements : None

virtual bool NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXOpen::Expression* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::VerticalLength ( )

Returns the expression containing the value for the vertical legth.

Only valid when the camera type is rectangle.
Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::ViewAngle ( )

Returns the expression containing the value for the view angle.


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.