Camera.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 _CAMERA_H
00025 #define _CAMERA_H
00026 
00027 #include "Primitive.h"
00028 #include "ConstrainableType.h"
00029 
00031 
00034 class XSIEXPORT CSLCamera
00035     : public CSLPrimitive, public CSLConstrainableType
00036 {
00037 public:
00038 
00044     CSLCamera(CSLScene* in_pScene, CSLModel *in_pModel, CdotXSITemplate* in_pTemplate);
00045 
00048     virtual ~CSLCamera();
00049 
00053     SI_Float GetFarPlane();
00054 
00058     SI_Void SetFarPlane(SI_Float in_fValue);
00059 
00063     SI_Float GetFieldOfView();
00064 
00068     SI_Void SetFieldOfView(SI_Float in_fValue);
00069 
00073     CSIBCVector3D GetInterestPosition();
00074 
00078     SI_Void SetInterestPosition(CSIBCVector3D& in_rValue);
00079 
00083     CSIBCVector3D GetPosition();
00084 
00088     SI_Void SetPosition(CSIBCVector3D& in_rValue);
00089 
00093     SI_Float GetNearPlane();
00094 
00098     SI_Void SetNearPlane(SI_Float in_fValue);
00099 
00103     virtual SI_Float GetRoll();
00104 
00108     virtual SI_Void SetRoll(SI_Float in_fValue);
00109 
00114     CSLConstraint* AddConstraint(CSLConstraint::EConstraintType in_ConstraintType);
00115 
00116     virtual SI_Error Synchronize();
00117     virtual ETemplateType Type();
00118     virtual CSLAnimatableType* ParameterFromName(SI_Char *in_szName);
00119 
00152     virtual CSLAnimatableType* ParameterFromType(EFCurveType in_Type, SI_Char *in_szParameterName);
00153 
00154     CSLVector3DProxy* GetInterestPositionProxy() { return &m_InterestPosition;};
00155     CSLVector3DProxy* GetPositionProxy() { return &m_Position;};
00156     CSLFloatProxy* GetRollProxy() { return &m_Roll;};
00157     CSLFloatProxy* GetFOVProxy() { return &m_FieldOfView;};
00158     CSLFloatProxy* GetNearPlaneProxy() { return &m_NearPlane;};
00159     CSLFloatProxy* GetFarPlaneProxy() { return &m_FarPlane;};
00160 
00161 private:
00162     CSLVector3DProxy m_InterestPosition;
00163     CSLVector3DProxy m_Position;
00164     CSLFloatProxy m_Roll;
00165     CSLFloatProxy m_FieldOfView;
00166     CSLFloatProxy m_NearPlane;
00167     CSLFloatProxy m_FarPlane;
00168 
00169     void *m_pReserved;  // reserved for future extension
00170 };
00171 
00172 #endif