HOM_Camera.h

Go to the documentation of this file.

 /*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __HOM_Camera_h__
#define __HOM_Camera_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include "HOM_Matrix3.h"
#include <UT/UT_CameraParms.h>
#include <UT/UT_Vector3.h>
#include <UT/UT_Matrix3.h>
#include <UT/UT_Matrix4.h>

// make sure our user facing name is hou.Camera
SWIGOUT(%rename(Camera) HOM_Camera;)

class HOM_API HOM_Camera
{
public:
    
    HOM_Camera();

    HOM_Camera(const HOM_Camera& camera);

    HOM_Camera(HOM_Matrix3 &xform, 
               HOM_Vector3 &position,
               std::map<std::string, hboost::any> parms);

    
    SWIGOUT(%ignore HOM_Camera(const UT_CameraParms &parms, 
                               const UT_Matrix3D &xform, 
                               const  UT_Vector3D &pos);)

    HOM_Camera(const UT_CameraParms &parms, 
               const UT_Matrix3D &xform, 
               const UT_Vector3D &pos) 
    : myParms(parms), myXform(xform), myPosition(pos)
    { HOM_CONSTRUCT_OBJECT(this) }

    ~HOM_Camera() { HOM_DESTRUCT_OBJECT(this) }

    std::string __repr__();

    
    /// Accessors
    HOM_Matrix3 *transform() const;
    HOM_Vector3 position() const;

    /// returns a dictionary of all the camera parameters
    ///     "aperture":41.42136,
    ///     "pixelaspect":1,
    ///     "clipnear": 0.001
    ///     "clipfar" :1000000,
    ///     "cropmax":[1,1],
    ///     "cropmin":[0,0],
    ///     "focal":50,
    ///     "focusdistance":10,
    ///     "fstop":22.1,
    ///     "orthozoom":1,
    ///     "guidescale": 1,
    ///     "imagingdistance": 1,
    ///     "projection":"perspective",
    ///     "resolutionx" :320,
    ///     "resolutiony" : 243,
    ///     "shutteropen" : 0
    ///     "shutterclose": 0,
    ///     "windowmax":[1,1],
    ///     "windowmin":[0,0]
    ///     "metadata": {}

    std::map<std::string, hboost::any> parms() const;

    /// returns a dictionary of the associated metadata
    std::map<std::string, hboost::any> metadata() const;
    
    double aperture() const;
    double pixelAspect() const;    
    double focal() const;
    double focusDistance() const;
    double imagingDistance() const;
    double fstop() const;
    double orthoZoom() const;
    double guideScale() const;
    
    HOM_EnumValue &projection() const;
    std::string projectionToken() const;
    bool isOrthographic() const;
    
    std::vector<int64> resolution() const;
    int64 resolutionX() const;
    int64 resolutionY() const;

    std::vector<double> cropMin() const;
    std::vector<double> cropMax() const;

    std::vector<double> windowMin() const;
    std::vector<double> windowMax() const;
    
    std::vector<double> clippingPlanes() const;
    double nearClippingPlane() const;
    double farClippingPlane() const;
    
    std::vector<double> shutter() const;
    double shutterOpen() const;
    double shutterClose() const;


    /// Setters
    
    void setTransform(HOM_Matrix3 &transform);
    void setPosition(HOM_Vector3 &position);
    void setParms(const std::map<std::string, hboost::any> &parms);

    void setAperture(double aperture);
    void setPixelAspect(double aspect);
    void setFocal(double focal);
    void setFocusDistance(double focusdist);
    void setImagingDistance(double imagingdist);
    void setFstop(double fstop);
    void setOrthoZoom(double zoom);
    void setGuideScale(double scale);
    
    void setProjection(HOM_EnumValue projection);
    
    void setResolution(const std::vector<int64> &res);
    void setResolutionX(int64 resx);
    void setResolutionY(int64 resy);  

    void setCropMin(const std::vector<double> &min);
    void setCropMax(const std::vector<double> &max);
    void setWindowMin(const std::vector<double> &min);
    void setWindowMax(const std::vector<double> &max);
    
    void setClippingPlanes(const std::vector<double> &planes);
    void setNearClippingPlane(double near);
    void setFarClippingPlane(double far);

    void setShutter(const std::vector<double> &shutter);
    void setShutterOpen(double sopen);
    void setShutterClose(double sclose);

    void setMetadata(const std::map<std::string, hboost::any> &metadata);

    SWIGOUT(%ignore getUTCameraParms;)
    const UT_CameraParms &getUTCameraParms() const { return myParms; };

    SWIGOUT(%ignore getXform;)
    UT_Matrix4D getXform() const 
    {
        UT_Matrix4D xform(myXform);
        xform.translate(myPosition);
        return xform;
    }
    
private:
    SWIGOUT(%ignore myParms;)
    UT_CameraParms myParms;
    
    SWIGOUT(%ignore myXform;)
    UT_Matrix3D myXform;
    
    SWIGOUT(%ignore myPosition;)
    UT_Vector3D myPosition;
    
};

#endif