OBJ/OBJ_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.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        OBJ library (C++)
 *
 * COMMENTS:    Camera object definition (base class for lights too)
 *
 */

#ifndef __OBJ_Camera_h__
#define __OBJ_Camera_h__

#include "OBJ_API.h"
#include "OBJ_Node.h"

class IFD_CameraParms;

enum OBJ_CamIndex
{
    I_N_CAM_INDICES = I_N_BASE_INDICES
};

class OBJ_API OBJ_Camera : public OBJ_Node
{
public:
             OBJ_Camera(OP_Network *, const char *, OP_Operator *);
    virtual ~OBJ_Camera();

    static PRM_Template         *getObsolete();
    static OP_Node              *myConstructor(OP_Network *net,
                                        const char *name, OP_Operator *entry);

    virtual unsigned             disableParms();

    virtual void                 getIFDParms(IFD_ObjectParms &parms, float t,
                                            const char *);
    virtual void                 getIFDParms(IFD_CameraParms &parms, float t,
                                            const char *);

    /// This will add to node parm interests on this' ifd parms.
    virtual void                 addInterestsOnIFDParms(OP_Node *node);

    virtual OBJ_OBJECT_TYPE      getObjectType() const;

    virtual void                 saveDialogScriptExtraInfo(ostream &os);

    static PRM_Template         *getTemplateList(OBJ_ParmsStyle style);


    virtual OBJ_Camera          *castToOBJCamera() { return this; }
    virtual OBJ_Camera          *getControllingCamera(fpreal now);

protected:
    // Used to get pointer to indirection indices for each object type
    virtual int                 *getIndirect() const
                                { return camIndirect; }

    // The camera does not use all of its parameters during a cook.  Therefore
    // in order to get the time dependencies right, we must override this.
    virtual bool                 cookedDataUsesAllParameters() const
                                 { return true; }

    virtual OP_ERROR     cookMyObj(OP_Context &ctx);

    virtual int          collectPropertiesFromParms(PI_EditScriptedParms &,
                                        UT_StringArray &names,
                                        PRM_ParmNameMap &nmap);
    virtual int          collectPropertiesFromChannels(PI_EditScriptedParms &,
                                        UT_BitArray &selection,
                                        const CH_ChannelList &channels);

public:         // Public so that other people can get this info
    // Take the winroll into account correctly
    void                 getWinParms(float &winx, float &winy,
                                    float &sizex, float &sizey,
                                    float &winroll, float now);

    // All projection methods are virtual to allow for blending of camera view.
    virtual int         PROJECTION(fpreal t);
    virtual fpreal      ORTHOW(fpreal t);
    virtual int         RESX(fpreal);
    virtual int         RESY(fpreal);
    virtual fpreal      ASPECT(fpreal t);
    virtual fpreal      FOCAL(fpreal t);
    virtual fpreal      APERTURE(fpreal t);
    virtual fpreal      SHUTTER(fpreal t);
    virtual fpreal      getNEAR(fpreal t);
    virtual fpreal      getFAR(fpreal t);
    virtual fpreal      CURVATURE(fpreal t);
    virtual fpreal      FSTOP(fpreal t);
    virtual fpreal      FOCUS(fpreal t);
    virtual fpreal      CROPL(fpreal t);
    virtual fpreal      CROPR(fpreal t);
    virtual fpreal      CROPB(fpreal t);
    virtual fpreal      CROPT(fpreal t);
    virtual fpreal      WINPX(fpreal t);
    virtual fpreal      WINPY(fpreal t);
    virtual fpreal      WINX(fpreal t);
    virtual fpreal      WINY(fpreal t);
    virtual fpreal      WINSIZEX(fpreal t);
    virtual fpreal      WINSIZEY(fpreal t);
    virtual fpreal      WINROLL(fpreal t);
    
    int                 ROTOSOURCE(fpreal now);
    void                ROTOFILE(UT_String &str, fpreal t);
    void                ROTOFILE_RAW(UT_String &str, fpreal t);
    int                 ROTO_OVERRIDE(fpreal now);
    int                 ROTO_RESX(fpreal t);
    int                 ROTO_RESY(fpreal t);
    void                COPPATH(UT_String &str, fpreal t);
    int                 TRACKWINCHANS(fpreal t);
    fpreal              COPFRAME(fpreal t);
    void                COPFRAME_RAW(UT_String &str, fpreal t);
    void                COLOR_PLANE(UT_String &str, fpreal t);
    int                 ALPHA_PLANE(fpreal);

    fpreal              CLEAR(fpreal t);
    int                 FOG(fpreal t);
    fpreal              FOGDENSITY(fpreal t);
    fpreal              FOGNEAR(fpreal t);
    fpreal              FOGFAR(fpreal t);
    fpreal              FOGCOLOR(fpreal t, int i);
    fpreal              FOGALPHA(fpreal t);

    void                VIEWCOMMENT(UT_String &str, fpreal t);
    virtual fpreal      MASKASPECT(fpreal t);
    virtual fpreal      MASKOPACITY(fpreal t);
    virtual void        MASKOVERLAY(UT_String &str, fpreal t);

protected:
    // This method should be called when evaluating "spare" parameters which
    // influence the cook.  Currently used by winroll.
    float               cookDependentFloat(const char *name, fpreal now,
                                int vi, fpreal defval);
private:
    static int                  *camIndirect;
};

#endif

---