XSICameraFocalLength.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 _XSICAMERAFOCALLENGTH_H
00025 #define _XSICAMERAFOCALLENGTH_H
00026 
00027 #include "Template.h"
00028 
00030 class XSIEXPORT CSLXSICameraFocalLength
00031     : public CSLTemplate
00032 {
00033 public:
00034 
00041     CSLXSICameraFocalLength(CSLScene* in_pScene, CSLModel *in_pModel, CdotXSITemplate* in_pTemplate);
00042 
00045     virtual ~CSLXSICameraFocalLength();
00046 
00050     SI_Float GetFocalLength();
00051 
00056     SI_Void SetFocalLength(SI_Float in_lValue);
00057 
00058 
00062     virtual ETemplateType           Type() { return XSI_CAMERA_FOCALLENGTH; }
00063 
00068     virtual SI_Error Synchronize();
00069 
00074     virtual CSLAnimatableType* ParameterFromName(SI_Char *in_szName);
00075 
00080     virtual CSLAnimatableType* ParameterFromType(EFCurveType in_Type, SI_Char *in_szName);
00081 
00086     virtual const SI_Char* GetParameterName(CSLAnimatableType* in_pParameter);
00087 
00088     CSLFloatProxy*  GetFocalLengthProxy() { return &m_FocalLength; };
00089 
00090 private:
00091 
00092     CSLFloatProxy   m_FocalLength;
00093 
00094     void *m_pReserved;  // reserved for future extension
00095 };
00096 
00097 #endif