DD::Image::TransformJack_ClientI Class Reference

#include <TransformJackKnobI.h>

Public Types
enum	TransformEvent {   EVENT_TRANSLATION , EVENT_ROTATE , EVENT_SKEW , EVENT_SCALE ,   EVENT_CORNERPIN , EVENT_PUSH , EVENT_RELEASE }

Public Member Functions
virtual bool	transformEvent (ViewerContext *ctx, const TransformJack_KnobI *transformJack, TransformEvent event)=0
virtual void	aboutToChange (ViewerContext *ctx, const TransformJack_KnobI *transformJack, int sourceFlags)=0
virtual void	finishedChange (ViewerContext *ctx, const TransformJack_KnobI *transformJack, int sourceFlags)=0
virtual bool	needsIndividualHandles () const
virtual bool	jackIsVisible ()

Detailed Description

A class that can be inherited from an object interested in using the transform jack making it a transform jack client which can receive update reports

Member Enumeration Documentation

TransformEvent

enum DD::Image::TransformJack_ClientI::TransformEvent

the transform event types

Member Function Documentation

transformEvent()

virtual bool DD::Image::TransformJack_ClientI::transformEvent ( ViewerContext *  ctx, const TransformJack_KnobI *  transformJack, TransformEvent  event  )

pure virtual

a function that signals the client of an event that is about to happen

Parameters

ctx	the current viewer context
event	the current event

Returns

indicates whether the event was handled or not, if the event is not accepted then the transform wont be performed on the bounding box

aboutToChange()

virtual void DD::Image::TransformJack_ClientI::aboutToChange ( ViewerContext *  ctx, const TransformJack_KnobI *  transformJack, int  sourceFlags  )

pure virtual

indicates that a change is about to happen

Parameters

ctx	the current viewer context
source	the source of the change about to happen

finishedChange()

virtual void DD::Image::TransformJack_ClientI::finishedChange ( ViewerContext *  ctx, const TransformJack_KnobI *  transformJack, int  sourceFlags  )

pure virtual

indicates that a change has just finished

Parameters

ctx	the viewer context for the change
source	the source of the change

needsIndividualHandles()

virtual bool DD::Image::TransformJack_ClientI::needsIndividualHandles ( ) const

inlinevirtual

indicates that this client requires an individual transform box. Defaults to false, meaning that all clients share a single transform box. Override if individual transform boxes are needed for each client

jackIsVisible()

virtual bool DD::Image::TransformJack_ClientI::jackIsVisible ( )

inlinevirtual

an overrideable function that can be used to signal if the jack is visible or not under certain circumstances

Returns

the state of the jack