pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::ICamera Interface Reference

Common camera interface. More...

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

Public Member Functions

void GetLookAt ([Out] GeVec3d% pEye,[Out] GeVec3d% pCenter,[Out] GeVec3d% pUp)
 Returns the camera postion and the camera target. More...
 
void SetLookAt (GeVec3d pEye, GeVec3d pCenter, GeVec3d pUp)
 Sets the camera postion and the camera target. More...
 
void ZoomToExtents (ReadOnlyCollection< String^ >^pEntities, double pMargin, double pAspect)
 Fits camera to given entities. More...
 
void ZoomToExtents (IEnumerable< DbEntity^ >^pEntities, double pMargin, double pAspect)
 Fits camera to given entities. More...
 
void CopyFrom (ICamera^ pOther)
 Assigns values of another camera object to this. More...
 

Properties

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

Common camera interface.

Member Function Documentation

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

Assigns values of another camera object to this.

Implemented in X3g::Plugin::Camera, and X3g::Plugin::CameraEntity.

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

Returns the camera postion and the camera target.

Implemented in X3g::Plugin::Camera, and X3g::Plugin::CameraEntity.

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

Sets the camera postion and the camera target.

Implemented in X3g::Plugin::Camera, and X3g::Plugin::CameraEntity.

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

Fits camera to given entities.

void X3g::Plugin::ICamera::ZoomToExtents ( IEnumerable< DbEntity^ >^  pEntities,
double  pMargin,
double  pAspect 
)

Fits camera to given entities.

Implemented in X3g::Plugin::Camera, and X3g::Plugin::CameraEntity.

Property Documentation

double X3g::Plugin::ICamera::DofAperture

The depth of field aperture/strength.

double X3g::Plugin::ICamera::DofDistance

The depth of field distance.

bool X3g::Plugin::ICamera::DofEnabled

True if depth of field is enabled.

double X3g::Plugin::ICamera::Fov

The fov (field of view) of perspective camera in degrees.

System:: String^ X3g::Plugin::ICamera::Name

Optional name of the camera.

May be empty and not unique.

CameraProjection X3g::Plugin::ICamera::Projection

The type of camera projection.

double X3g::Plugin::ICamera::YMag

Y magnification of orthographic camera.