Represents a Display::CameraBuilder
Cameras are not supported in KF. More...

Inheritance diagram for NXOpen::Display::CameraBuilder:

Public Types
enum	Aperture { ApertureF28, ApertureF56, ApertureF8, ApertureF11, ApertureF16, ApertureF22 }
	Predefined apertures: f2.8, f5.6, f8, f11, f16, f22. More...

enum	FovMeasured { FovMeasuredHorizontally, FovMeasuredVertically }
	either horizontal or vertical measure More...

enum	LensAngle { LensAngleStock, LensAngleFov, LensAngleMagnification }
	the way to define the field of view angle More...

enum	LensFlare { LensFlareStandard, LensFlareS35, LensFlareS50, LensFlareS105, LensFlarePolygonal, LensFlareP35, LensFlareP50, LensFlareP105, LensFlareSpark, LensFlareStar }
	Predefined lens flare types: Standard, 35mm, 50mm, 105mm, polygonal, 35mm poly, 50mm poly, 105mm poly, spark, star. More...

enum	StockLens { StockLensS28, StockLensS35, StockLensS50, StockLensS70, StockLensS105, StockLensS135, StockLensS210, StockLensS300 }
	Predefined lenses: 28, 35, 50, 70, 105, 135, 210, 300mm. More...

enum	Types { TypesParallel, TypesPerspective }
	the camera types More...

Public Member Functions
NXOpen::Display::CameraBuilder::Aperture	ApertureType ()
	Returns the aperture Created in NX5.0.0.

double	BackClippingDistance ()
	Returns the back clipping distance Created in NX5.0.0.

NXOpen::Matrix3x3	CameraMatrix ()
	Returns the camera rotation matrix Created in NX5.0.0.

NXString	CameraName ()
	Returns the camera name as a TEXT string.

NXString	CameraNameChar ()
	Returns the camera name as a char string Created in NX5.0.1.

NXOpen::Point3d	CameraPosition ()
	Returns the coordinates of the camera point Created in NX5.0.0.

bool	DepthOfFieldToggle ()
	Returns the depth of field toggle Created in NX5.0.0.

double	FieldOfViewAngle ()
	Returns the field of view angle Created in NX5.0.0.

NXOpen::Display::CameraBuilder::FovMeasured	FieldOfViewMeasured ()
	Returns the field of view measured Created in NX5.0.0.

double	FocalDistance ()
	Returns the focal distance Created in NX5.0.0.

double	FrontClippingDistance ()
	Returns the front clipping distance Created in NX5.0.0.

bool	HiddenLensFlareToggle ()
	Returns the hidden lens flare toggle Created in NX5.0.0.

NXOpen::Display::CameraBuilder::LensAngle	LensAngleType ()
	Returns the lens angle Created in NX5.0.0.

double	LensFlareIntensity ()
	Returns the lens flare intensity Created in NX5.0.0.

bool	LensFlareToggle ()
	Returns the lens flare toggle Created in NX5.0.0.

NXOpen::Display::CameraBuilder::LensFlare	LensFlareType ()
	Returns the lens flare type Created in NX5.0.0.

double	Magnification ()
	Returns the magnification Created in NX5.0.0.

double	PerspectiveDistance ()
	Returns the perspective distance Created in NX5.0.0.

void	SetApertureType (NXOpen::Display::CameraBuilder::Aperture apertureType)
	Sets the aperture Created in NX5.0.0.

void	SetBackClippingDistance (double backClippingDistance)
	Sets the back clipping distance Created in NX5.0.0.

void	SetCameraMatrix (const NXOpen::Matrix3x3 &cameraMatrix)
	Sets the camera rotation matrix Created in NX5.0.0.

void	SetCameraName (const NXString &cameraName)
	Sets the camera name as a TEXT string.

void	SetCameraName (const char *cameraName)
	Sets the camera name as a TEXT string.

void	SetCameraNameChar (const NXString &cameraName)
	Sets the camera name as a char string Created in NX5.0.1.

void	SetCameraNameChar (const char *cameraName)
	Sets the camera name as a char string Created in NX5.0.1.

void	SetCameraPosition (const NXOpen::Point3d &position)
	Sets the coordinates of the camera point Created in NX5.0.0.

void	SetDepthOfFieldToggle (bool depthOfFieldToggle)
	Sets the depth of field toggle Created in NX5.0.0.

void	SetFieldOfViewAngle (double fieldOfViewAngle)
	Sets the field of view angle Created in NX5.0.0.

void	SetFieldOfViewMeasured (NXOpen::Display::CameraBuilder::FovMeasured fovMeasuredType)
	Sets the field of view measured Created in NX5.0.0.

void	SetFocalDistance (double focalDistance)
	Sets the focal distance Created in NX5.0.0.

void	SetFrontClippingDistance (double frontClippingDistance)
	Sets the front clipping distance Created in NX5.0.0.

void	SetHiddenLensFlareToggle (bool hiddenLensFlareToggle)
	Sets the hidden lens flare toggle Created in NX5.0.0.

void	SetLensAngleType (NXOpen::Display::CameraBuilder::LensAngle lensAngleType)
	Sets the lens angle Created in NX5.0.0.

void	SetLensFlareIntensity (double lensFlareIntensity)
	Sets the lens flare intensity Created in NX5.0.0.

void	SetLensFlareToggle (bool lensFlareToggle)
	Sets the lens flare toggle Created in NX5.0.0.

void	SetLensFlareType (NXOpen::Display::CameraBuilder::LensFlare lensFlareType)
	Sets the lens flare type Created in NX5.0.0.

void	SetMagnification (double magnification)
	Sets the magnification Created in NX5.0.0.

void	SetPerspectiveDistance (double perspectiveDistance)
	Sets the perspective distance Created in NX5.0.0.

void	SetStockLensType (NXOpen::Display::CameraBuilder::StockLens stockLensType)
	Sets the stock lens type Created in NX5.0.0.

void	SetTargetMatrix (const NXOpen::Matrix3x3 &matrix)
	Sets the target point rotation matrix Created in NX5.0.0.

void	SetTargetPosition (const NXOpen::Point3d &position)
	Sets the coordinates of the target point Created in NX5.0.0.

void	SetType (NXOpen::Display::CameraBuilder::Types type)
	Sets the camera type Created in NX5.0.0.

void	SetUseTargetPoint (bool useTargetPoint)
	Sets whether to use the target point Created in NX5.0.0.

NXOpen::Display::CameraBuilder::StockLens	StockLensType ()
	Returns the stock lens type Created in NX5.0.0.

NXOpen::Matrix3x3	TargetMatrix ()
	Returns the target point rotation matrix Created in NX5.0.0.

NXOpen::Point3d	TargetPosition ()
	Returns the coordinates of the target point Created in NX5.0.0.

NXOpen::Display::CameraBuilder::Types	Type ()
	Returns the camera type Created in NX5.0.0.

bool	UseTargetPoint ()
	Returns whether to use the target point Created in NX5.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

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

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 a Display::CameraBuilder
Cameras are not supported in KF.

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::CameraBuilder::Aperture

Predefined apertures: f2.8, f5.6, f8, f11, f16, f22.

Enumerator:

ApertureF28	f2.8
ApertureF56	f5.6
ApertureF8	f8
ApertureF11	f11
ApertureF16	f16
ApertureF22	f22

enum NXOpen::Display::CameraBuilder::FovMeasured

either horizontal or vertical measure

Enumerator:

FovMeasuredHorizontally	Horizontal.
FovMeasuredVertically	Vertical.

enum NXOpen::Display::CameraBuilder::LensAngle

the way to define the field of view angle

Enumerator:

LensAngleStock	Stock Lenses.
LensAngleFov	Field of View.
LensAngleMagnification	Magnification.

enum NXOpen::Display::CameraBuilder::LensFlare

Predefined lens flare types: Standard, 35mm, 50mm, 105mm, polygonal, 35mm poly, 50mm poly, 105mm poly, spark, star.

Enumerator:

LensFlareStandard	Standard lens.
LensFlareS35	35mm
LensFlareS50	50mm
LensFlareS105	105mm
LensFlarePolygonal	polygonal
LensFlareP35	35mm poly
LensFlareP50	50mm poly
LensFlareP105	105mm poly
LensFlareSpark	spark lens
LensFlareStar	star lens

enum NXOpen::Display::CameraBuilder::StockLens

Predefined lenses: 28, 35, 50, 70, 105, 135, 210, 300mm.

Enumerator:

StockLensS28	28mm
StockLensS35	35mm
StockLensS50	50mm
StockLensS70	70mm
StockLensS105	105mm
StockLensS135	135mm
StockLensS210	210mm
StockLensS300	300mm

enum NXOpen::Display::CameraBuilder::Types

the camera types

Enumerator:

TypesParallel	Parallel Projection.
TypesPerspective	Perspective Projection.

Member Function Documentation

NXOpen::Display::CameraBuilder::Aperture NXOpen::Display::CameraBuilder::ApertureType ( )

Returns the aperture
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::BackClippingDistance ( )

Returns the back clipping distance
Created in NX5.0.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::Display::CameraBuilder::CameraMatrix ( )

Returns the camera rotation matrix
Created in NX5.0.0.

License requirements : None

NXString NXOpen::Display::CameraBuilder::CameraName ( )

Returns the camera name as a TEXT string.

Note that internally the camera name is stored as a char* string. Any characters which cannot be mapped to 8-bit characters will be replaced by # characters.
Created in NX5.0.0.

License requirements : None

NXString NXOpen::Display::CameraBuilder::CameraNameChar ( )

Returns the camera name as a char string
Created in NX5.0.1.

License requirements : None

NXOpen::Point3d NXOpen::Display::CameraBuilder::CameraPosition ( )

Returns the coordinates of the camera point
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::CameraBuilder::DepthOfFieldToggle ( )

Returns the depth of field toggle
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::FieldOfViewAngle ( )

Returns the field of view angle
Created in NX5.0.0.

License requirements : None

NXOpen::Display::CameraBuilder::FovMeasured NXOpen::Display::CameraBuilder::FieldOfViewMeasured ( )

Returns the field of view measured
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::FocalDistance ( )

Returns the focal distance
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::FrontClippingDistance ( )

Returns the front clipping distance
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::CameraBuilder::HiddenLensFlareToggle ( )

Returns the hidden lens flare toggle
Created in NX5.0.0.

License requirements : None

NXOpen::Display::CameraBuilder::LensAngle NXOpen::Display::CameraBuilder::LensAngleType ( )

Returns the lens angle
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::LensFlareIntensity ( )

Returns the lens flare intensity
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::CameraBuilder::LensFlareToggle ( )

Returns the lens flare toggle
Created in NX5.0.0.

License requirements : None

NXOpen::Display::CameraBuilder::LensFlare NXOpen::Display::CameraBuilder::LensFlareType ( )

Returns the lens flare type
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::Magnification ( )

Returns the magnification
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::CameraBuilder::PerspectiveDistance ( )

Returns the perspective distance
Created in NX5.0.0.

License requirements : None

void NXOpen::Display::CameraBuilder::SetApertureType ( NXOpen::Display::CameraBuilder::Aperture apertureType )

Sets the aperture
Created in NX5.0.0.

License requirements : None

Parameters

apertureType aperturetype

void NXOpen::Display::CameraBuilder::SetBackClippingDistance ( double backClippingDistance )

Sets the back clipping distance
Created in NX5.0.0.

License requirements : None

Parameters

backClippingDistance backclippingdistance

void NXOpen::Display::CameraBuilder::SetCameraMatrix ( const NXOpen::Matrix3x3 & cameraMatrix )

Sets the camera rotation matrix
Created in NX5.0.0.

License requirements : None

Parameters

cameraMatrix camera matrix

void NXOpen::Display::CameraBuilder::SetCameraName ( const NXString & cameraName )

Sets the camera name as a TEXT string.

Note that internally the camera name is stored as a char* string. Any characters which cannot be mapped to 8-bit characters will be replaced by # characters.
Created in NX5.0.0.

License requirements : None

Parameters

cameraName camera name

void NXOpen::Display::CameraBuilder::SetCameraName ( const char * cameraName )

Sets the camera name as a TEXT string.

Note that internally the camera name is stored as a char* string. Any characters which cannot be mapped to 8-bit characters will be replaced by # characters.
Created in NX5.0.0.

License requirements : None

Parameters

cameraName camera name

void NXOpen::Display::CameraBuilder::SetCameraNameChar ( const NXString & cameraName )

Sets the camera name as a char string
Created in NX5.0.1.

License requirements : None

Parameters

cameraName camera name

void NXOpen::Display::CameraBuilder::SetCameraNameChar ( const char * cameraName )

Sets the camera name as a char string
Created in NX5.0.1.

License requirements : None

Parameters

cameraName camera name

void NXOpen::Display::CameraBuilder::SetCameraPosition ( const NXOpen::Point3d & position )

Sets the coordinates of the camera point
Created in NX5.0.0.

License requirements : None

Parameters

position position

void NXOpen::Display::CameraBuilder::SetDepthOfFieldToggle ( bool depthOfFieldToggle )

Sets the depth of field toggle
Created in NX5.0.0.

License requirements : None

Parameters

depthOfFieldToggle depthoffieldtoggle

void NXOpen::Display::CameraBuilder::SetFieldOfViewAngle ( double fieldOfViewAngle )

Sets the field of view angle
Created in NX5.0.0.

License requirements : None

Parameters

fieldOfViewAngle fieldofviewangle

void NXOpen::Display::CameraBuilder::SetFieldOfViewMeasured ( NXOpen::Display::CameraBuilder::FovMeasured fovMeasuredType )

Sets the field of view measured
Created in NX5.0.0.

License requirements : None

Parameters

fovMeasuredType fovmeasuredtype

void NXOpen::Display::CameraBuilder::SetFocalDistance ( double focalDistance )

Sets the focal distance
Created in NX5.0.0.

License requirements : None

Parameters

focalDistance focaldistance

void NXOpen::Display::CameraBuilder::SetFrontClippingDistance ( double frontClippingDistance )

Sets the front clipping distance
Created in NX5.0.0.

License requirements : None

Parameters

frontClippingDistance frontclippingdistance

void NXOpen::Display::CameraBuilder::SetHiddenLensFlareToggle ( bool hiddenLensFlareToggle )

Sets the hidden lens flare toggle
Created in NX5.0.0.

License requirements : None

Parameters

hiddenLensFlareToggle hiddenlensflaretoggle

void NXOpen::Display::CameraBuilder::SetLensAngleType ( NXOpen::Display::CameraBuilder::LensAngle lensAngleType )

Sets the lens angle
Created in NX5.0.0.

License requirements : None

Parameters

lensAngleType lensangletype

void NXOpen::Display::CameraBuilder::SetLensFlareIntensity ( double lensFlareIntensity )

Sets the lens flare intensity
Created in NX5.0.0.

License requirements : None

Parameters

lensFlareIntensity lensflareintensity

void NXOpen::Display::CameraBuilder::SetLensFlareToggle ( bool lensFlareToggle )

Sets the lens flare toggle
Created in NX5.0.0.

License requirements : None

Parameters

lensFlareToggle lensflaretoggle

void NXOpen::Display::CameraBuilder::SetLensFlareType ( NXOpen::Display::CameraBuilder::LensFlare lensFlareType )

Sets the lens flare type
Created in NX5.0.0.

License requirements : None

Parameters

lensFlareType lensflaretype

void NXOpen::Display::CameraBuilder::SetMagnification ( double magnification )

Sets the magnification
Created in NX5.0.0.

License requirements : None

Parameters

magnification magnification

void NXOpen::Display::CameraBuilder::SetPerspectiveDistance ( double perspectiveDistance )

Sets the perspective distance
Created in NX5.0.0.

License requirements : None

Parameters

perspectiveDistance perspectivedistance

void NXOpen::Display::CameraBuilder::SetStockLensType ( NXOpen::Display::CameraBuilder::StockLens stockLensType )

Sets the stock lens type
Created in NX5.0.0.

License requirements : None

Parameters

stockLensType stocklenstype

void NXOpen::Display::CameraBuilder::SetTargetMatrix ( const NXOpen::Matrix3x3 & matrix )

Sets the target point rotation matrix
Created in NX5.0.0.

License requirements : None

Parameters

matrix matrix

void NXOpen::Display::CameraBuilder::SetTargetPosition ( const NXOpen::Point3d & position )

Sets the coordinates of the target point
Created in NX5.0.0.

License requirements : None

Parameters

position position

void NXOpen::Display::CameraBuilder::SetType ( NXOpen::Display::CameraBuilder::Types type )

Sets the camera type
Created in NX5.0.0.

License requirements : None

Parameters

type type

void NXOpen::Display::CameraBuilder::SetUseTargetPoint ( bool useTargetPoint )

Sets whether to use the target point
Created in NX5.0.0.

License requirements : None

Parameters

useTargetPoint usetargetpoint

NXOpen::Display::CameraBuilder::StockLens NXOpen::Display::CameraBuilder::StockLensType ( )

Returns the stock lens type
Created in NX5.0.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::Display::CameraBuilder::TargetMatrix ( )

Returns the target point rotation matrix
Created in NX5.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Display::CameraBuilder::TargetPosition ( )

Returns the coordinates of the target point
Created in NX5.0.0.

License requirements : None

NXOpen::Display::CameraBuilder::Types NXOpen::Display::CameraBuilder::Type ( )

Returns the camera type
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::CameraBuilder::UseTargetPoint ( )

Returns whether to use the target point
Created in NX5.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Display_CameraBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation