XSICamera.h

00001 //***************************************************************************************
00002 //
00003 // File supervisor: Softimage 3D Games & 3D Bridge team
00004 //
00005 // (c) Copyright 2001-2002 Avid Technology, Inc. . All rights reserved.
00006 //
00007 //***************************************************************************************
00008 
00009 /****************************************************************************************
00010 THIS CODE IS PUBLISHED AS A SAMPLE ONLY AND IS PROVIDED "AS IS".
00011 IN NO EVENT SHALL SOFTIMAGE, AVID TECHNOLOGY, INC. AND/OR THEIR RESPECTIVE
00012 SUPPLIERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
00013 DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00014 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
00015 CONNECTION WITH THE USE OR PERFORMANCE OF THIS CODE .
00016 
00017 COPYRIGHT NOTICE. Copyright © 1999-2002 Avid Technology Inc. . All rights reserved. 
00018 
00019 SOFTIMAGE is a registered trademark of Avid Technology Inc. or its subsidiaries 
00020 or divisions. Windows NT is a registered trademark of Microsoft Corp. All other
00021 trademarks contained herein are the property of their respective owners. 
00022 ****************************************************************************************/
00023 
00024 #ifndef _XSICAMERA_H
00025 #define _XSICAMERA_H
00026 
00027 #include "Primitive.h"
00028 
00029 class CSLXSICameraFocalLength;
00030 
00032 class XSIEXPORT CSLXSICamera
00033     : public CSLPrimitive
00034 {
00035 public:
00036 
00043     CSLXSICamera(CSLScene* in_pScene, CSLModel *in_pModel, CdotXSITemplate* in_pTemplate);
00044 
00047     virtual ~CSLXSICamera();
00048 
00052     SI_Int GetStandard();
00053 
00058     SI_Void SetStandard(SI_Int in_lValue);
00059 
00063     SI_Float GetPictureRatio();
00064 
00069     SI_Void SetPictureRatio(SI_Float in_lValue);
00070 
00074     SI_Float GetFieldOfView();
00075 
00080     SI_Void SetFieldOfView(SI_Float in_lValue);
00081 
00085     SI_Int GetFieldOfViewType();
00086 
00091     SI_Void SetFieldOfViewType(SI_Int in_lValue);
00092 
00096     SI_Int GetProjectionType();
00097 
00102     SI_Void SetProjectionType(SI_Int in_lValue);
00103 
00107     SI_Float GetOrthoHeight();
00108 
00113     SI_Void SetOrthoHeight(SI_Float in_lValue);
00114 
00118     SI_Float GetInterestDistance();
00119 
00124     SI_Void SetInterestDistance(SI_Float in_lValue);
00125 
00129     SI_Float GetNearPlane();
00130 
00135     SI_Void SetNearPlane(SI_Float in_lValue);
00136 
00140     SI_Float GetFarPlane();
00141 
00146     SI_Void SetFarPlane(SI_Float in_lValue);
00147 
00151     SI_Bool GetProjectionPlaneEnable();
00152 
00157     SI_Void SetProjectionPlaneEnable(SI_Bool in_lValue);
00158 
00162     SI_Float GetProjPlaneWidth();
00163 
00168     SI_Void SetProjPlaneWidth(SI_Float in_lValue);
00169 
00173     SI_Float GetProjPlaneHeight();
00174 
00179     SI_Void SetProjPlaneHeight(SI_Float in_lValue);
00180 
00184     SI_Float GetProjPlaneOffsetX();
00185 
00190     SI_Void SetProjPlaneOffsetX(SI_Float in_lValue);
00191 
00195     SI_Float GetProjPlaneOffsetY();
00196 
00201     SI_Void SetProjPlaneOffsetY(SI_Float in_lValue);
00202 
00206     virtual ETemplateType           Type() { return XSI_CAMERA; }
00207 
00212     virtual SI_Error Synchronize();
00213 
00218     virtual CSLAnimatableType* ParameterFromName(SI_Char *in_szName);
00219 
00224     virtual CSLAnimatableType* ParameterFromType(EFCurveType in_Type, SI_Char *in_szName);
00225 
00230     virtual const SI_Char* GetParameterName(CSLAnimatableType* in_pParameter);
00231 
00232     CSLIntProxy*    GetStandardProxy() { return &m_Standard;};
00233     CSLFloatProxy*  GetPictureRatioProxy() { return &m_PictureAspect;};
00234     CSLFloatProxy*  GetFieldOfViewProxy() { return &m_Fov;};
00235     CSLIntProxy*    GetFieldOfViewTypeProxy() { return &m_FovType;};
00236     CSLIntProxy*    GetProjectionTypeProxy() { return &m_ProjType;};
00237     CSLFloatProxy*  GetOrthoHeightProxy() { return &m_OrthoHeight;};
00238     CSLFloatProxy*  GetInterestDistanceProxy() { return &m_InterestDistance;};
00239     CSLFloatProxy*  GetNearPlaneProxy() { return &m_NearPlane;};
00240     CSLFloatProxy*  GetFarPlaneProxy() { return &m_FarPlane;};
00241     CSLBoolProxy*   GetProjectionPlaneEnableProxy() { return &m_useProjPlane;};
00242     CSLFloatProxy*  GetProjPlaneWidthProxy() { return &m_ProjPlaneWidth;};
00243     CSLFloatProxy*  GetProjPlaneHeightProxy() { return &m_ProjPlaneHeight;};
00244     CSLFloatProxy*  GetProjPlaneOffsetXProxy() { return &m_ProjPlaneOffsetX;};
00245     CSLFloatProxy*  GetProjPlaneOffsetYProxy() { return &m_ProjPlaneOffsetY;};
00246 
00247     CSLXSICameraFocalLength*    CreateXSICameraFocalLength();
00248     CSLXSICameraFocalLength*    GetXSICameraFocalLength();
00249     CSLXSICameraFocalLength*    ConnectXSICameraFocalLength(CSLXSICameraFocalLength* in_pToConnect);
00250 
00251 private:
00252 
00253     CSLIntProxy     m_Standard;
00254     CSLFloatProxy   m_PictureAspect;
00255     CSLFloatProxy   m_Fov;
00256     CSLIntProxy     m_FovType;
00257     CSLIntProxy     m_ProjType;
00258     CSLFloatProxy   m_OrthoHeight;
00259     CSLFloatProxy   m_InterestDistance;
00260     CSLFloatProxy   m_NearPlane;
00261     CSLFloatProxy   m_FarPlane;
00262     CSLBoolProxy    m_useProjPlane;
00263     CSLFloatProxy   m_ProjPlaneWidth;
00264     CSLFloatProxy   m_ProjPlaneHeight;
00265     CSLFloatProxy   m_ProjPlaneOffsetX;
00266     CSLFloatProxy   m_ProjPlaneOffsetY;
00267     CSLXSICameraFocalLength*    m_pXSICameraFocalLength;
00268 
00269     void *m_pReserved;  // reserved for future extension
00270 };
00271 
00272 #endif