pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Properties | List of all members
X3g::Plugin::CameraEntity Class Reference

Camera entity. More...

Inheritance diagram for X3g::Plugin::CameraEntity:
Inheritance graph
[legend]

Public Member Functions

virtual void GetLookAt ([Out] X3g::Plugin::GeVec3d% pEye,[Out] X3g::Plugin::GeVec3d% pCenter,[Out] X3g::Plugin::GeVec3d% pUp)
 Get orientation of the CameraEntity. More...
 
virtual void SetLookAt (X3g::Plugin::GeVec3d pEye, X3g::Plugin::GeVec3d pCenter, X3g::Plugin::GeVec3d pUp)
 Set CameraEntity position and rotation. More...
 
virtual void ZoomToExtents (ReadOnlyCollection< System::String^ >^pEntities, double pMargin, double pAspect)
 Zoom camera in/out to have all the given entities in view. More...
 
virtual void ZoomToExtents (IEnumerable< DbEntity^ >^pEntities, double pMargin, double pAspect)
 Zoom camera in/out to have all the given entities in view. More...
 
virtual void CopyFrom (X3g::Plugin::ICamera^ pOther)
 Copy settings from another camera. More...
 
- Public Member Functions inherited from X3g::Plugin::ICamera
void ZoomToExtents (ReadOnlyCollection< String^ >^pEntities, double pMargin, double pAspect)
 Fits camera to given entities. More...
 

Static Public Member Functions

static CameraEntityFromDbEntity (DbEntity^ pEntity)
 Returns CameraEntity if given DbEntity is a camera. More...
 

Properties

virtual System::String^  Name [get, set]
 The name of the camera. More...
 
virtual
X3g::Plugin::CameraProjection 
Projection [get, set]
 Set or get the projection of the CameraEntity. More...
 
virtual double Fov [get, set]
 Set or get the field of view. More...
 
virtual double YMag [get, set]
 Set or get Y magnification of orthographic camera. More...
 
virtual bool DofEnabled [get, set]
 Enable or disable the depth of field effect. More...
 
virtual double DofDistance [get, set]
 Set or get the depth of field value. More...
 
virtual double DofAperture [get, set]
 Set or get the value of lens aperture / depth of field strength. More...
 
- Properties inherited from X3g::Plugin::ICamera
System::String^  Name
 Optional name of the camera. More...
 
CameraProjection Projection
 The type of camera projection. More...
 
double Fov
 The fov (field of view) of perspective camera in degrees. More...
 
double YMag
 Y magnification of orthographic camera. More...
 
bool DofEnabled
 True if depth of field is enabled. More...
 
double DofDistance
 The depth of field distance. More...
 
double DofAperture
 The depth of field aperture/strength. More...
 

Detailed Description

Camera entity.

Member Function Documentation

void X3g::Plugin::CameraEntity::CopyFrom ( X3g::Plugin::ICamera pOther)
virtual

Copy settings from another camera.

Implements X3g::Plugin::ICamera.

CameraEntity X3g::Plugin::CameraEntity::FromDbEntity ( DbEntity pEntity)
static

Returns CameraEntity if given DbEntity is a camera.

Otherwise it returns null.

void X3g::Plugin::CameraEntity::GetLookAt ( [Out] X3g::Plugin::GeVec3d pEye,
[Out] X3g::Plugin::GeVec3d pCenter,
[Out] X3g::Plugin::GeVec3d pUp 
)
virtual

Get orientation of the CameraEntity.

Implements X3g::Plugin::ICamera.

void X3g::Plugin::CameraEntity::SetLookAt ( X3g::Plugin::GeVec3d  pEye,
X3g::Plugin::GeVec3d  pCenter,
X3g::Plugin::GeVec3d  pUp 
)
virtual

Set CameraEntity position and rotation.

Parameters
pEyePosition of the camera / eye.
pCenterThe camera / eye will be rotated to have the point pCenter in its center of view.
pUpRotate the camera so the pUp vector is aligned with the up-direction of the cameras view.

Implements X3g::Plugin::ICamera.

void X3g::Plugin::CameraEntity::ZoomToExtents ( ReadOnlyCollection< System::String^ >^  pEntities,
double  pMargin,
double  pAspect 
)
virtual

Zoom camera in/out to have all the given entities in view.

Parameters
pEntitiesCollection of entities to have in view.
pMarginMargin to keep around the entities.
pAspectThe aspect ratio of the desired view.
void X3g::Plugin::CameraEntity::ZoomToExtents ( IEnumerable< DbEntity^ >^  pEntities,
double  pMargin,
double  pAspect 
)
virtual

Zoom camera in/out to have all the given entities in view.

Parameters
pEntitiesEnumerable of entities to have in view.
pMarginMargin to keep around the entities.
pAspectThe aspect ratio of the desired view.

Implements X3g::Plugin::ICamera.

Property Documentation

virtual double X3g::Plugin::CameraEntity::DofAperture
getset

Set or get the value of lens aperture / depth of field strength.

virtual double X3g::Plugin::CameraEntity::DofDistance
getset

Set or get the depth of field value.

virtual bool X3g::Plugin::CameraEntity::DofEnabled
getset

Enable or disable the depth of field effect.

virtual double X3g::Plugin::CameraEntity::Fov
getset

Set or get the field of view.

virtual System:: String^ X3g::Plugin::CameraEntity::Name
getset

The name of the camera.

virtual X3g:: Plugin:: CameraProjection X3g::Plugin::CameraEntity::Projection
getset

Set or get the projection of the CameraEntity.

virtual double X3g::Plugin::CameraEntity::YMag
getset

Set or get Y magnification of orthographic camera.