SoEvent man page on IRIX

Man page or keyword search:  
man Server   31559 pages
apropos Keyword Search (all sections)
Output format
IRIX logo
[printable version]



								  SoEvent(3IV)

NAME
     SoEvent (SoEv) - base class for all events

INHERITS FROM
     SoEvent

SYNOPSIS
     #include <Inventor_c/events/SoEvent.h>

     typedef SoEvent	 SoEv

	  Functions from class SoEvent:

     SoEvent *		 SoEvCreate()
     void		 SoEvDelete(SoEv *this)
     SoType		 SoEvGetTypeId(const SoEv *this)
     SoType		 SoEvGetClassTypeId()
     SbBool		 SoEvIsOfType(const SoEv *this, SoType type)
     void		 SoEvSetTime(SoEv *this, SbTime t)
     SbTime		 SoEvGetTime(const SoEv *this)
     void		 SoEvSetPos(SoEv *this, const SbVec2s *p)
     const SbVec2s *	 SoEvGetPos(const SoEv *this)
     const SbVec2s *	 SoEvGetPosInVP(const SoEv *this, const
			      SbViewportRegion *vpRgn)
     const SbVec2f *	 SoEvGetNormPos(const SoEv *this, const
			      SbViewportRegion *vpRgn)
     void		 SoEvSetShiftDown(SoEv *this, SbBool isDown)
     void		 SoEvSetCtrlDown(SoEv *this, SbBool isDown)
     void		 SoEvSetAltDown(SoEv *this, SbBool isDown)
     SbBool		 SoEvWasShiftDown(const SoEv *this)
     SbBool		 SoEvWasCtrlDown(const SoEv *this)
     SbBool		 SoEvWasAltDown(const SoEv *this)

DESCRIPTION
     SoEvent is the base class for events in the Inventor event model. An
     event typically represents a user action, such as a mouse button being
     pressed or a keyboard key being released. SoEvent contains general
     information found in all Inventor events, including the time the event
     occurred, the position of the locater when the event occurred, and the
     state of the modifier keys when the event occurred.

FUNCTIONS
     SoEvent *		 SoEvCreate()
     void		 SoEvDelete(SoEv *this)
	  Constructor and destructor.

     SoType		 SoEvGetTypeId(const SoEv *this)
	  Return the type id for this event instance.

     SoType		 SoEvGetClassTypeId()
	  Return the type id for the SoEvent class.

Page 1

SoEvent(3IV)

     SbBool		 SoEvIsOfType(const SoEv *this, SoType type)
	  This returns TRUE if the event is an instance of or derived from an
	  event of the passed type.

     void		 SoEvSetTime(SoEv *this, SbTime t)
     SbTime		 SoEvGetTime(const SoEv *this)
	  Set and get the time at which the event occurred.

     void		 SoEvSetPos(SoEv *this, const SbVec2s *p)
     const SbVec2s *	 SoEvGetPos(const SoEv *this)
	  Set the window pixel location of the cursor when the event occurred.
	  The position is relative to the lower left corner of the window in
	  which the event occurred.

     const SbVec2s *	 SoEvGetPosInVP(const SoEv *this, const
			      SbViewportRegion *vpRgn)
	  Get the viewport pixel location of the cursor when the event
	  occurred, relative to the specified viewport region.

     const SbVec2f *	 SoEvGetNormPos(const SoEv *this, const
			      SbViewportRegion *vpRgn)
	  Get the normalized location of the cursor when the event occurred,
	  relative to the specified viewport region. The returned value will
	  lie between 0.0 and 1.0.

     void		 SoEvSetShiftDown(SoEv *this, SbBool isDown)
     void		 SoEvSetCtrlDown(SoEv *this, SbBool isDown)
     void		 SoEvSetAltDown(SoEv *this, SbBool isDown)
	  Set whether the modifier keys were down when the event occurred.

     SbBool		 SoEvWasShiftDown(const SoEv *this)
     SbBool		 SoEvWasCtrlDown(const SoEv *this)
     SbBool		 SoEvWasAltDown(const SoEv *this)
	  Get whether the modifier keys were down when the event occurred.

SEE ALSO
     SoButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event,
     SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction,
     SoEventCallback, SoSelection, SoInteraction, SoXtDevice, SoXtRenderArea

Page 2

[top]

List of man pages available for IRIX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net