This reference page is linked to from the following overview topics: Object Plug-ins, Plug-in Base Classes.
Detailed Description
- See also:
- Class CameraObject,
Class Interval, Class
Control.
- Description:
- This class describes a generic camera object. It is used as a base class for creating plug-in cameras. Methods of this class are used to get and set properties of the camera. All methods of this class are virtual.
#include <gencam.h>
Inheritance diagram for GenCamera:
Public Member Functions |
|
| virtual GenCamera * | NewCamera (int type)=0 |
| virtual void | SetConeState (int s)=0 |
| virtual int | GetConeState ()=0 |
| virtual void | SetHorzLineState (int s)=0 |
| virtual int | GetHorzLineState ()=0 |
| virtual void | Enable (int enab)=0 |
| virtual BOOL | SetFOVControl (Control *c)=0 |
| virtual void | SetFOVType (int ft)=0 |
| virtual int | GetFOVType ()=0 |
| virtual Control * | GetFOVControl ()=0 |
| virtual int | Type ()=0 |
| virtual void | SetType (int tp)=0 |
| virtual void | SetDOFEnable (TimeValue t, BOOL onOff) |
| virtual BOOL | GetDOFEnable (TimeValue t, Interval &valid=Interval(0, 0)) |
| virtual void | SetDOFFStop (TimeValue t, float fs) |
| virtual float | GetDOFFStop (TimeValue t, Interval &valid=Interval(0, 0)) |
Member Function Documentation
| virtual GenCamera* NewCamera | ( | int | type | ) | [pure virtual] |
- Remarks:
- Creates a new generic camera object.
- Parameters:
- int type
Nonzero if the camera has a target; otherwise 0.
- Returns:
- A pointer to a new instance of the specified light type.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual void SetConeState | ( | int | s | ) | [pure virtual] |
- Remarks:
- Sets if the camera cone is displayed in the viewports.
- Parameters:
- int s
Nonzero to display the camera cone; otherwise 0.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual int GetConeState | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the camera cone is displayed in the viewports; otherwise FALSE.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual void SetHorzLineState | ( | int | s | ) | [pure virtual] |
- Remarks:
- Sets if the camera has a horizon line displayed.
- Parameters:
- int s
Nonzero to display the horizon line; otherwise 0.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual int GetHorzLineState | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the camera has a horizon line displayed; otherwise FALSE.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual void Enable | ( | int | enab | ) | [pure virtual] |
- Remarks:
- Enables or disables the camera. If enabled the camera may be displayed, hit tested, etc.
- Parameters:
- int enab
Nonzero to enable; zero to disable.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual BOOL SetFOVControl | ( | Control * | c | ) | [pure virtual] |
- Remarks:
- Sets the controller for the field-of-view parameter.
- Parameters:
- Control
*c
Points to the controller to set.
- Returns:
- Returns TRUE if set; otherwise FALSE.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual void SetFOVType | ( | int | ft | ) | [pure virtual] |
- Remarks:
- This method is available in release 3.0 and later only.
Sets the Field-Of-View type of the camera.
- Parameters:
- int ft
One of the following values:
FOV_W
Width-related FOV
FOV_H
Height-related FOV
FOV_D
Diagonal-related FOV
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual int GetFOVType | ( | ) | [pure virtual] |
- Remarks:
- This method is available in release 3.0 and later only.
Returns the Field-Of-View type of the camera. One of the following values:
FOV_W
Width-related FOV
FOV_H
Height-related FOV
FOV_D
Diagonal-related FOV
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual Control* GetFOVControl | ( | ) | [pure virtual] |
- Remarks:
- Returns the controller for the field-of-view parameter.
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual int Type | ( | ) | [pure virtual] |
- Remarks:
- This method is available in release 3.0 and later only.
Returns one of the following values to indicate the camera type:
FREE_CAMERA (No Target)
TARGETED_CAMERA (Target / Look At Controller)
PARALLEL_CAMERA (Orthographic Camera)
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual void SetType | ( | int | tp | ) | [pure virtual] |
- Remarks:
- This method is available in release 3.0 and later only.
Sets the type of camera.
- Parameters:
- int tp
One of the following types:
FREE_CAMERA (No Target)
TARGETED_CAMERA (Target / Look At Controller)
PARALLEL_CAMERA (Orthographic Camera)
Implemented in MSPluginCamera, and MSCameraXtnd.
| virtual void SetDOFEnable | ( | TimeValue | t, |
| BOOL | onOff | ||
| ) | [inline, virtual] |
| virtual void SetDOFFStop | ( | TimeValue | t, |
| float | fs | ||
| ) | [inline, virtual] |
