UI_OHTriggerObject.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.
 *
 * NAME:        UI_OHTriggerObject.h ( Op Handler Library, C++)
 *
 * COMMENTS:
 *              This is a little helper class. I need to be able to have
 *              UI interests, yet I can't subclass UI_OHEventHandler off a
 *              UI_Object because that prevents multiple inheritance of
 *              UI_OHEventHandler and some UI_Object based class, making
 *              UI_OHEventHandler useless. So, I just contain this little
 *              UI_Object for expressing interests in UI events.
 */

#ifndef __UI_OHTriggerObject__
#define __UI_OHTriggerObject__

#include "UI_API.h"
#include "UI_Object.h"
#include "UI_Value.h"

class UI_OHEventHandler;

class UI_API UI_OHTriggerObject : public UI_Object
{
public:
                         UI_OHTriggerObject(UI_OHEventHandler &);
                        ~UI_OHTriggerObject() override;

    const char          *className() const override;

    void                 addTimeInterest();
    void                 removeTimeInterest();
    void                 sendTriggerEvent();

    // getTimeValue returns nullptr if you haven't set a time interest
    UI_Value            *getTimeValue() { return myTimeValue; }

    // getTime returns 0 if you haven't set a time interest
    fpreal               getTime() const { return myTimeValue ?  
                                                (fpreal)*myTimeValue : 0; }

private:
    void                 handleTriggerEvent(UI_Event *);
    void                 handleTimeChange(UI_Event *);

    UI_Value            *myTimeValue;
    UI_OHEventHandler   &myEventHandler;
};

#endif