Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

soqtobject(3) [debian man page]

SoQtObject(3)							       SoQt							     SoQtObject(3)

NAME

       SoQtObject -

       The SoQtObject class is the common superclass for all SoQt component classes.

       The purpose of making this class the superclass of all SoQt device, component and viewer classes is to be able to do run-time type checking
       of the SoQt objects.

SYNOPSIS

       #include <Inventor/Qt/SoQtObject.h>

       Inherited by SoQtComponent, and SoQtDevice.

   Public Member Functions
       virtual SoType getTypeId (void) const =0
       SbBool isOfType (SoType type) const

   Static Public Member Functions
       static void initClass (void)
       static SoType getClassTypeId (void)
       static void init (void)

Detailed Description
       The SoQtObject class is the common superclass for all SoQt component classes.

       The purpose of making this class the superclass of all SoQt device, component and viewer classes is to be able to do run-time type checking
       of the SoQt objects.

       You can place the macro SOQT_OBJECT_HEADER(classname,parentname) within a class definition header for SoQt extension components to
       automatically make the necessary definitions for setting up a run-time type system for your extension classes:

	 #ifndef MYSPECIALVIEWER_H
	 #define MYSPECIALVIEWER_H

	 class MySpecialViewer : public SoQtExaminerViewer {
	   SOQT_OBJECT_HEADER(MySpecialViewer, SoQtExaminerViewer);
	   // [rest of class definition follows]
	 };

	 #endif // !MYSPECIALVIEWER_H

       Then put the SOQT_OBJECT_SOURCE(classname) macro within the actual implementation sourcecode file to include the necessary code for the
       run-time type system:

	 #include <MySpecialViewer.h>

	 SOQT_OBJECT_SOURCE(MySpecialViewer);

	 // [rest of class implementation]

       See also the documentation of the SoType class in Coin or Inventor.

Member Function Documentation
   void SoQtObject::initClass (void) [static] Sets up initialization for data common to all instances of this class, submitting necessary
       information to the internal SoQt type system.
       Referenced by init(), SoQtDevice::initClasses(), and SoQtComponent::initClasses().

   SoType SoQtObject::getClassTypeId (void) [static] This static method returns the SoType object associated with objects of this class.
       Referenced by SoQtViewer::setCameraType(), SoQtViewer::setSceneGraph(), SoQtRenderArea::sizeChanged(), SoQtViewer::SoQtViewer(), and
       SoQtViewer::toggleCameraType().

   SoType SoQtObject::getTypeId (void) const [pure virtual] Returns the type identification of an object derived from a class inheriting
       SoQtObject. This is used for run-time type checking and 'downward' casting.
       Usage example:

	 void foo(SoQtViewer * comp)
	 {
	   if (comp->getTypeId() == SoQtExaminerViewer::getClassTypeId()) {
	     // safe downward cast, knows the type
	     SoQtExaminerViewer * exviewer = (SoQtExaminerViewer *)comp;
	   }
	   else if (comp->getTypeId().isOfType(SoQtFlyViewer::getClassTypeId())) {
	     // safe downward cast, knows the type
	     SoQtFlyViewer * flyviewer = (SoQtFlyViewer *)comp;
	     // then something else
	   }
	 }

       Referenced by isOfType(), and SoQtRenderArea::sizeChanged().

   SbBool SoQtObject::isOfType (SoTypetype) const Returns TRUE if the type of this object is either of the same type or inherited from type.
       References getTypeId().

   void SoQtObject::init (void) [static] Initialize the type system of SoQtObject, all SoQt device classes and all SoQt components (including
       viewers).
       References initClass(), SoQtDevice::initClasses(), and SoQtComponent::initClasses().

Author
       Generated automatically by Doxygen for SoQt from the source code.

Version 1.5.0							  Sun Dec 11 2011						     SoQtObject(3)

Check Out this Related Man Page

Qt Components(3)                                                       SoQt                                                       Qt Components(3)

NAME

       Qt Components -

   Classes
       class SoQtGLWidget
           The SoQtGLWidget class manages OpenGL contexts.

       This is the basic, abstract component class which sets up an OpenGL canvas for its subclasses. "
   class SoQtRenderArea
       The SoQtRenderArea class adds scenegraph handling and event management.

       The SoQtRenderArea class is a component that adds scenegraph management and input device event handling to the SoQtGLWidget component. "
   class SoQtConstrainedViewer
       The SoQtConstrainedViewer class is the superclass for viewers with constrains on the viewpoint.

       This abstract viewer class adds new methods to keep the camera in an upright position according to some arbitrary up-direction. The up-
       direction can be decided by either the application programmer (by using SoQtConstrainedViewer::setUpDirection()) or the end-user, through
       interaction mechanisms defined by the subclasses. "
   class SoQtExaminerViewer
       The SoQtExaminerViewer class is a 3D-model examination viewer.

       This class is the viewer considered to be the most 'general purpose' viewer, and it is often used in rapid prototyping to examine simple
       models aswell as complete scenes (although for the latter, you might be better off with one of the other viewer classes). "
   class SoQtFullViewer
       The SoQtFullViewer class adds some user interface components to the viewer canvas.

       The SoQtFullViewer is an abstract viewer class which extends it's superclass (the basic SoQtViewer class) with two major user interface
       additions: "
   class SoQtPlaneViewer
       The SoQtPlaneViewer class is for examining 3D models by moving the camera in orthogonal planes.

       The SoQtPlaneViewer is a viewer that is useful for 'CAD-style' applications, where you want the end-user to examine your model with the
       viewpoint set from one of the three principal axes. "
   class SoQtViewer
       The SoQtViewer class is the top level base viewer class.

       This is an abstract class, which adds the following features to it's SoQtRenderArea superclass: convenient methods for camera handling, an
       automatic headlight configuration. "

Author
       Generated automatically by Doxygen for SoQt from the source code.

Version 1.5.0                                                     Sun Dec 11 2011                                                 Qt Components(3)
Man Page