NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::CameraBuilder Class Reference

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

Inheritance diagram for NXOpen::Display::CameraBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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 SetCameraNameChar (const NXString &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.

Detailed Description

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



Created in NX5.0.0.


Member Enumeration Documentation

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

either horizontal or vertical measure

Enumerator:
FovMeasuredHorizontally 

Horizontal.

FovMeasuredVertically 

Vertical.

the way to define the field of view angle

Enumerator:
LensAngleStock 

Stock Lenses.

LensAngleFov 

Field of View.

LensAngleMagnification 

Magnification.

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

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

the camera types

Enumerator:
TypesParallel 

Parallel Projection.

TypesPerspective 

Perspective Projection.


Member Function Documentation

Returns the aperture
Created in NX5.0.0.



License requirements : None

Returns the back clipping distance
Created in NX5.0.0.



License requirements : None

Returns the camera rotation matrix
Created in NX5.0.0.



License requirements : None

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the focal distance
Created in NX5.0.0.



License requirements : None

Returns the front clipping distance
Created in NX5.0.0.



License requirements : None

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



License requirements : None

Returns the lens angle
Created in NX5.0.0.



License requirements : None

Returns the lens flare intensity
Created in NX5.0.0.



License requirements : None

Returns the lens flare toggle
Created in NX5.0.0.



License requirements : None

Returns the lens flare type
Created in NX5.0.0.



License requirements : None

Returns the magnification
Created in NX5.0.0.



License requirements : None

Returns the perspective distance
Created in NX5.0.0.



License requirements : None

Sets the aperture
Created in NX5.0.0.



License requirements : None

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

Sets the back clipping distance
Created in NX5.0.0.



License requirements : None

Parameters:
backClippingDistancebackclippingdistance

Sets the camera rotation matrix
Created in NX5.0.0.



License requirements : None

Parameters:
cameraMatrixcamera matrix

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

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



License requirements : None

Parameters:
cameraNamecamera name

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



License requirements : None

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

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



License requirements : None

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

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



License requirements : None

Parameters:
fieldOfViewAnglefieldofviewangle

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



License requirements : None

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

Sets the focal distance
Created in NX5.0.0.



License requirements : None

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

Sets the front clipping distance
Created in NX5.0.0.



License requirements : None

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

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



License requirements : None

Parameters:
hiddenLensFlareTogglehiddenlensflaretoggle

Sets the lens angle
Created in NX5.0.0.



License requirements : None

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

Sets the lens flare intensity
Created in NX5.0.0.



License requirements : None

Parameters:
lensFlareIntensitylensflareintensity

Sets the lens flare toggle
Created in NX5.0.0.



License requirements : None

Parameters:
lensFlareTogglelensflaretoggle

Sets the lens flare type
Created in NX5.0.0.



License requirements : None

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

Sets the magnification
Created in NX5.0.0.



License requirements : None

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

Sets the perspective distance
Created in NX5.0.0.



License requirements : None

Parameters:
perspectiveDistanceperspectivedistance

Sets the stock lens type
Created in NX5.0.0.



License requirements : None

Parameters:
stockLensTypestocklenstype

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



License requirements : None

Parameters:
matrixmatrix

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



License requirements : None

Parameters:
positionposition

Sets the camera type
Created in NX5.0.0.



License requirements : None

Parameters:
typetype

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



License requirements : None

Parameters:
useTargetPointusetargetpoint

Returns the stock lens type
Created in NX5.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the camera type
Created in NX5.0.0.



License requirements : None

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.