NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::Display::AnimationCameraBuilder Class Reference

Represents a animation camera builder
To create a new instance of this class, use NXOpen::Display::AnimationCameraCollection::CreateAnimationCameraBuilder

Created in NX1847.0.0. More...

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

Public Member Functions

NXOpen::PointCameraConstrainedPoint ()
 Returns the camera constrained point
Created in NX1847.0.0. More...
 
NXOpen::DirectionCameraConstrainedUpperVector ()
 Returns the camera constrained upper vector
Created in NX1847.0.0. More...
 
bool CameraPositioningConstrained ()
 Returns the camera positioning constrained
Created in NX1847.0.0. More...
 
NXOpen::SelectTaggedObjectCameraTransformSource ()
 Returns the camera transform source
Created in NX1847.0.0. More...
 
void SetCameraConstrainedPoint (NXOpen::Point *cameraConstrainedPoint)
 Sets the camera constrained point
Created in NX1847.0.0. More...
 
void SetCameraConstrainedUpperVector (NXOpen::Direction *cameraUpperVector)
 Sets the camera constrained upper vector
Created in NX1847.0.0. More...
 
void SetCameraPositioningConstrained (bool positioningConstrained)
 Sets the camera positioning constrained
Created in NX1847.0.0. More...
 
void SetTargetConstrainedPoint (NXOpen::Point *position)
 Sets the target constrained point
Created in NX1847.0.0. More...
 
void SetTargetPositioningConstrained (bool positioningConstrained)
 Sets the target positioning constrained
Created in NX1847.0.0. More...
 
NXOpen::PointTargetConstrainedPoint ()
 Returns the target constrained point
Created in NX1847.0.0. More...
 
bool TargetPositioningConstrained ()
 Returns the target positioning constrained
Created in NX1847.0.0. More...
 
NXOpen::SelectTaggedObjectTargetTransformSource ()
 Returns the target transform source
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::Display::CameraBuilder
NXOpen::Display::CameraBuilder::Aperture ApertureType ()
 Returns the aperture
Created in NX5.0.0. More...
 
double BackClippingDistance ()
 Returns the back clipping distance
Created in NX5.0.0. More...
 
NXOpen::Matrix3x3 CameraMatrix ()
 Returns the camera rotation matrix
Created in NX5.0.0. More...
 
NXString CameraName ()
 Returns the camera name as a TEXT string. More...
 
NXString CameraNameChar ()
 Returns the camera name as a char string
Created in NX5.0.1. More...
 
NXOpen::Point3d CameraPosition ()
 Returns the coordinates of the camera point
Created in NX5.0.0. More...
 
bool DepthOfFieldToggle ()
 Returns the depth of field toggle
Created in NX5.0.0. More...
 
double FieldOfViewAngle ()
 Returns the field of view angle
Created in NX5.0.0. More...
 
NXOpen::Display::CameraBuilder::FovMeasured FieldOfViewMeasured ()
 Returns the field of view measured
Created in NX5.0.0. More...
 
double FocalDistance ()
 Returns the focal distance
Created in NX5.0.0. More...
 
double FrontClippingDistance ()
 Returns the front clipping distance
Created in NX5.0.0. More...
 
bool HiddenLensFlareToggle ()
 Returns the hidden lens flare toggle
Created in NX5.0.0. More...
 
NXOpen::Display::CameraBuilder::LensAngle LensAngleType ()
 Returns the lens angle
Created in NX5.0.0. More...
 
double LensFlareIntensity ()
 Returns the lens flare intensity
Created in NX5.0.0. More...
 
bool LensFlareToggle ()
 Returns the lens flare toggle
Created in NX5.0.0. More...
 
NXOpen::Display::CameraBuilder::LensFlare LensFlareType ()
 Returns the lens flare type
Created in NX5.0.0. More...
 
double Magnification ()
 Returns the magnification
Created in NX5.0.0. More...
 
double PerspectiveDistance ()
 Returns the perspective distance
Created in NX5.0.0. More...
 
void SetApertureType (NXOpen::Display::CameraBuilder::Aperture apertureType)
 Sets the aperture
Created in NX5.0.0. More...
 
void SetBackClippingDistance (double backClippingDistance)
 Sets the back clipping distance
Created in NX5.0.0. More...
 
void SetCameraMatrix (const NXOpen::Matrix3x3 &cameraMatrix)
 Sets the camera rotation matrix
Created in NX5.0.0. More...
 
void SetCameraName (const NXString &cameraName)
 Sets the camera name as a TEXT string. More...
 
void SetCameraName (const char *cameraName)
 Sets the camera name as a TEXT string. More...
 
void SetCameraNameChar (const NXString &cameraName)
 Sets the camera name as a char string
Created in NX5.0.1. More...
 
void SetCameraNameChar (const char *cameraName)
 Sets the camera name as a char string
Created in NX5.0.1. More...
 
void SetCameraPosition (const NXOpen::Point3d &position)
 Sets the coordinates of the camera point
Created in NX5.0.0. More...
 
void SetDepthOfFieldToggle (bool depthOfFieldToggle)
 Sets the depth of field toggle
Created in NX5.0.0. More...
 
void SetFieldOfViewAngle (double fieldOfViewAngle)
 Sets the field of view angle
Created in NX5.0.0. More...
 
void SetFieldOfViewMeasured (NXOpen::Display::CameraBuilder::FovMeasured fovMeasuredType)
 Sets the field of view measured
Created in NX5.0.0. More...
 
void SetFocalDistance (double focalDistance)
 Sets the focal distance
Created in NX5.0.0. More...
 
void SetFrontClippingDistance (double frontClippingDistance)
 Sets the front clipping distance
Created in NX5.0.0. More...
 
void SetHiddenLensFlareToggle (bool hiddenLensFlareToggle)
 Sets the hidden lens flare toggle
Created in NX5.0.0. More...
 
void SetLensAngleType (NXOpen::Display::CameraBuilder::LensAngle lensAngleType)
 Sets the lens angle
Created in NX5.0.0. More...
 
void SetLensFlareIntensity (double lensFlareIntensity)
 Sets the lens flare intensity
Created in NX5.0.0. More...
 
void SetLensFlareToggle (bool lensFlareToggle)
 Sets the lens flare toggle
Created in NX5.0.0. More...
 
void SetLensFlareType (NXOpen::Display::CameraBuilder::LensFlare lensFlareType)
 Sets the lens flare type
Created in NX5.0.0. More...
 
void SetMagnification (double magnification)
 Sets the magnification
Created in NX5.0.0. More...
 
void SetPerspectiveDistance (double perspectiveDistance)
 Sets the perspective distance
Created in NX5.0.0. More...
 
void SetStockLensType (NXOpen::Display::CameraBuilder::StockLens stockLensType)
 Sets the stock lens type
Created in NX5.0.0. More...
 
void SetTargetMatrix (const NXOpen::Matrix3x3 &matrix)
 Sets the target point rotation matrix
Created in NX5.0.0. More...
 
void SetTargetPosition (const NXOpen::Point3d &position)
 Sets the coordinates of the target point
Created in NX5.0.0. More...
 
void SetType (NXOpen::Display::CameraBuilder::Types type)
 Sets the camera type
Created in NX5.0.0. More...
 
void SetUseTargetPoint (bool useTargetPoint)
 Sets whether to use the target point
Created in NX5.0.0. More...
 
NXOpen::Display::CameraBuilder::StockLens StockLensType ()
 Returns the stock lens type
Created in NX5.0.0. More...
 
NXOpen::Matrix3x3 TargetMatrix ()
 Returns the target point rotation matrix
Created in NX5.0.0. More...
 
NXOpen::Point3d TargetPosition ()
 Returns the coordinates of the target point
Created in NX5.0.0. More...
 
NXOpen::Display::CameraBuilder::Types Type ()
 Returns the camera type
Created in NX5.0.0. More...
 
bool UseTargetPoint ()
 Returns whether to use the target point
Created in NX5.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...
 

Additional Inherited Members

- Public Types inherited from NXOpen::Display::CameraBuilder
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...
 

Detailed Description

Represents a animation camera builder
To create a new instance of this class, use NXOpen::Display::AnimationCameraCollection::CreateAnimationCameraBuilder

Created in NX1847.0.0.


Member Function Documentation

NXOpen::Point* NXOpen::Display::AnimationCameraBuilder::CameraConstrainedPoint ( )

Returns the camera constrained point
Created in NX1847.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Display::AnimationCameraBuilder::CameraConstrainedUpperVector ( )

Returns the camera constrained upper vector
Created in NX1847.0.0.



License requirements : None

bool NXOpen::Display::AnimationCameraBuilder::CameraPositioningConstrained ( )

Returns the camera positioning constrained
Created in NX1847.0.0.



License requirements : None

NXOpen::SelectTaggedObject* NXOpen::Display::AnimationCameraBuilder::CameraTransformSource ( )

Returns the camera transform source
Created in NX1847.0.0.



License requirements : None

void NXOpen::Display::AnimationCameraBuilder::SetCameraConstrainedPoint ( NXOpen::Point cameraConstrainedPoint)

Sets the camera constrained point
Created in NX1847.0.0.



License requirements : None

Parameters
cameraConstrainedPointcameraconstrainedpoint
void NXOpen::Display::AnimationCameraBuilder::SetCameraConstrainedUpperVector ( NXOpen::Direction cameraUpperVector)

Sets the camera constrained upper vector
Created in NX1847.0.0.



License requirements : None

Parameters
cameraUpperVectorcamerauppervector
void NXOpen::Display::AnimationCameraBuilder::SetCameraPositioningConstrained ( bool  positioningConstrained)

Sets the camera positioning constrained
Created in NX1847.0.0.



License requirements : None

Parameters
positioningConstrainedpositioningconstrained
void NXOpen::Display::AnimationCameraBuilder::SetTargetConstrainedPoint ( NXOpen::Point position)

Sets the target constrained point
Created in NX1847.0.0.



License requirements : None

Parameters
positionposition
void NXOpen::Display::AnimationCameraBuilder::SetTargetPositioningConstrained ( bool  positioningConstrained)

Sets the target positioning constrained
Created in NX1847.0.0.



License requirements : None

Parameters
positioningConstrainedpositioningconstrained
NXOpen::Point* NXOpen::Display::AnimationCameraBuilder::TargetConstrainedPoint ( )

Returns the target constrained point
Created in NX1847.0.0.



License requirements : None

bool NXOpen::Display::AnimationCameraBuilder::TargetPositioningConstrained ( )

Returns the target positioning constrained
Created in NX1847.0.0.



License requirements : None

NXOpen::SelectTaggedObject* NXOpen::Display::AnimationCameraBuilder::TargetTransformSource ( )

Returns the target transform source
Created in NX1847.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.