Bcf_3_0PerspectiveCamera.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _BCF_3_0_PERSPECTIVE_CAMERA_H
#define _BCF_3_0_PERSPECTIVE_CAMERA_H
 
#include "BcfCommon.h"
 
#include "BcfElement.h"

namespace OdBcf_3_0 {
 
  class OdBcfPoint;
  typedef OdSmartPtr<OdBcfPoint> OdBcfPointPtr;
 
  class OdBcfDirection;
  typedef OdSmartPtr<OdBcfDirection> OdBcfDirectionPtr;

  class BCF_3_0_EXPORT OdBcfPerspectiveCamera : public OdBcf::OdBcfElement
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfPerspectiveCamera);
    //DOM-IGNORE-END

    static OdSmartPtr<OdBcfPerspectiveCamera> createObject(
      const OdBcfPointPtr     &pCameraViewPoint,
      const OdBcfDirectionPtr &pCameraDirection,
      const OdBcfDirectionPtr &pCameraUpVector,
      double                   fieldOfView,
      double                   aspectRatio);

    OdBcfPerspectiveCamera();

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    const OdBcfPointPtr& getCameraViewPoint() const;

    bool isCameraViewPointUnset() const;

    const OdBcfDirectionPtr& getCameraDirection() const;

    bool isCameraDirectionUnset() const;

    const OdBcfDirectionPtr& getCameraUpVector() const;

    bool isCameraUpVectorUnset() const;

    const double& getFieldOfView() const;

    bool isFieldOfViewUnset() const;

    const double& getAspectRatio() const;

    bool isAspectRatioUnset() const;
 
 
    //DOM-IGNORE-BEGIN
  protected:
    OdBcfPointPtr     m_pCameraViewPoint;
    OdBcfDirectionPtr m_pCameraDirection;
    OdBcfDirectionPtr m_pCameraUpVector;
    double            m_fieldOfView;
    double            m_aspectRatio;

    virtual bool validateData() const ODRX_OVERRIDE;
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfPerspectiveCamera> OdBcfPerspectiveCameraPtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_PERSPECTIVE_CAMERA_H