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

Inheritance diagram for NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder:

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::Axis *	CameraAxis ()
	Returns the selected axis defining the camera direction.

NXOpen::CoordinateSystem *	CameraCsys ()
	Returns the coordinate system specifying the camera position.

NXOpen::ScCollector *	CameraFace ()
	Returns the face selections used to identify the camera surface.

NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types	CameraType ()
	Returns the camera definition type used by the close range visibility.

bool	FaceReverse ()
	Returns the indication if the selected camera face surface should be reversed.

NXOpen::Expression *	HorizontalLength ()
	Returns the expression containing the value for the horizontal legth.

NXOpen::Expression *	InitialRadius ()
	Returns the expression containing the value for the initial radius.

void	SetCameraAxis (NXOpen::Axis *cameraAxis)
	Sets the selected axis defining the camera direction.

void	SetCameraCsys (NXOpen::CoordinateSystem *cameraCsys)
	Sets the coordinate system specifying the camera position.

void	SetCameraType (NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types cameraType)
	Sets the camera definition type used by the close range visibility.

void	SetFaceReverse (bool faceReverse)
	Sets the indication if the selected camera face surface should be reversed.

void	SetUseCamera (bool useCamera)
	Sets the indication if the defined camera will be used for visibility compute.

bool	UseCamera ()
	Returns the indication if the defined camera will be used for visibility compute.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

NXOpen::Expression *	VerticalLength ()
	Returns the expression containing the value for the vertical legth.

NXOpen::Expression *	ViewAngle ()
	Returns the expression containing the value for the view angle.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

<br> To create a new instance of this class, use @link Features::VehicleDesign::CloseRangeVisibilityBuilder::CreateCameraListItemBuilder  Features::VehicleDesign::CloseRangeVisibilityBuilder::CreateCameraListItemBuilder @endlink  <br>

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Features::VehicleDesign::CloseRangeCameraListItemBuilder::Types

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::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

cameraAxis cameraaxis

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

cameraCsys cameracsys

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

cameraType cameratype

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

faceReverse facereverse

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

useCamera usecamera

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:

Features_VehicleDesign_CloseRangeCameraListItemBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation