Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MouseWatcherRegion Class Reference

This is the class that defines a rectangular region on the screen for the MouseWatcher. More...

Inheritance diagram for MouseWatcherRegion:
TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject PGMouseWatcherBackground

Public Types

enum  SuppressFlags { SF_mouse_button = 1, SF_other_button = 2, SF_any_button = 3, SF_mouse_position = 4 }
 

Public Member Functions

 __init__ (const MouseWatcherRegion)
 
 __init__ (str name, const LVecBase4 frame)
 
 __init__ (str name, float left, float right, float bottom, float top)
 
bool getActive ()
 Returns whether the region is active or not. More...
 
float getArea ()
 Returns the area of the rectangular region. More...
 
const LVecBase4 getFrame ()
 
bool getKeyboard ()
 Returns whether the region is interested in global keyboard events; see set_keyboard(). More...
 
int getSort ()
 Returns the current sorting order of this region. More...
 
int getSuppressFlags ()
 Returns the current suppress_flags. More...
 
 output (Ostream out)
 
 setActive (bool active)
 Sets whether the region is active or not. More...
 
 setFrame (const LVecBase4 frame)
 
 setFrame (float left, float right, float bottom, float top)
 
 setKeyboard (bool keyboard)
 Sets whether the region is interested in global keyboard events. More...
 
 setSort (int sort)
 Changes the sorting order of this particular region. More...
 
 setSuppressFlags (int suppress_flags)
 Sets which events are suppressed when the mouse is over the region. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Public Attributes

bool active
 Returns whether the region is active or not. More...
 
float area
 Returns the area of the rectangular region. More...
 
const LVecBase4 frame
 
bool keyboard
 Returns whether the region is interested in global keyboard events; see set_keyboard(). More...
 
int sort
 Returns the current sorting order of this region. More...
 
int suppress_flags
 Returns the current suppress_flags. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 
- Public Attributes inherited from Namable
const String name
 

Detailed Description

This is the class that defines a rectangular region on the screen for the MouseWatcher.

Member Enumeration Documentation

◆ SuppressFlags

Enumerator
SF_mouse_button 
SF_other_button 
SF_any_button 
SF_mouse_position 

Member Function Documentation

◆ __init__() [1/3]

__init__ ( const  MouseWatcherRegion)

◆ __init__() [2/3]

__init__ ( str  name,
const LVecBase4  frame 
)

◆ __init__() [3/3]

__init__ ( str  name,
float  left,
float  right,
float  bottom,
float  top 
)

◆ getActive()

bool getActive ( )

Returns whether the region is active or not.

See set_active().

◆ getArea()

float getArea ( )

Returns the area of the rectangular region.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getFrame()

const LVecBase4 getFrame ( )

◆ getKeyboard()

bool getKeyboard ( )

Returns whether the region is interested in global keyboard events; see set_keyboard().

◆ getSort()

int getSort ( )

Returns the current sorting order of this region.

See set_sort().

◆ getSuppressFlags()

int getSuppressFlags ( )

Returns the current suppress_flags.

See set_suppress_flags().

◆ output()

output ( Ostream  out)

◆ setActive()

setActive ( bool  active)

Sets whether the region is active or not.

If it is not active, the MouseWatcher will never consider the mouse to be over the region. The region might still receive keypress events if its set_keyboard() flag is true.

◆ setFrame() [1/2]

setFrame ( const LVecBase4  frame)

◆ setFrame() [2/2]

setFrame ( float  left,
float  right,
float  bottom,
float  top 
)

◆ setKeyboard()

setKeyboard ( bool  keyboard)

Sets whether the region is interested in global keyboard events.

If this is true, then any keyboard button events will be passed to press() and release() regardless of the position of the mouse onscreen; otherwise, these events will only be passed if the mouse is over the region.

◆ setSort()

setSort ( int  sort)

Changes the sorting order of this particular region.

The sorting order is used to resolve conflicts in the case of overlapping region; the region with the highest sort value will be preferred, and between regions of the same sort value, the smallest region will be preferred. The default sorting order, if none is explicitly specified, is 0.

◆ setSuppressFlags()

setSuppressFlags ( int  suppress_flags)

Sets which events are suppressed when the mouse is over the region.

This is the union of zero or more various SF_* values. Normally, this is 0, indicating that no events are suppressed.

If you set this to a non-zero value, for instance SF_mouse_position, then the mouse position will not be sent along the data graph when the mouse is over this particular region.

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ active

bool active

Returns whether the region is active or not.

See set_active().

◆ area

float area

Returns the area of the rectangular region.

◆ frame

const LVecBase4 frame

◆ keyboard

bool keyboard

Returns whether the region is interested in global keyboard events; see set_keyboard().

◆ sort

int sort

Returns the current sorting order of this region.

See set_sort().

◆ suppress_flags

int suppress_flags

Returns the current suppress_flags.

See set_suppress_flags().