debian man page for sosfbox2s

SoSFBox2s(3)							       Coin							      SoSFBox2s(3)

NAME
       SoSFBox2s -

       The SoSFBox2s class is a container for an SbBox2s vector.

       This field is used where nodes, engines or other field containers needs to store a box.

SYNOPSIS
       #include <Inventor/fields/SoSFBox2s.h>

       Inherits SoSField.

   Public Member Functions
       virtual SoType getTypeId (void) const
       virtual void copyFrom (const SoField &field)
       const SoSFBox2s & operator= (const SoSFBox2s &field)
       virtual SbBool isSame (const SoField &field) const
       const SbBox2s & getValue (void) const
       void setValue (const SbBox2s &newvalue)
       const SbBox2s & operator= (const SbBox2s &newvalue)
       int operator== (const SoSFBox2s &field) const
       int operator!= (const SoSFBox2s &field) const
       void setValue (short xmin, short ymin, short xmax, short ymax)
       void setValue (SbVec2s minvec, SbVec2s maxvec)
       void getValue (SbBox2s &box) const

   Static Public Member Functions
       static void * createInstance (void)
       static SoType getClassTypeId (void)
       static void initClass (void)

   Protected Attributes
       SbBox2s value

   Additional Inherited Members
Detailed Description
       The SoSFBox2s class is a container for an SbBox2s vector.

       This field is used where nodes, engines or other field containers needs to store a box.

       Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

       Since:
	   Coin 2.5

Member Function Documentation
   SoType SoSFBox2s::getClassTypeId (void) [static]
       Returns a unique type identifier for this field class.

       See also:
	   getTypeId(), SoType

       Reimplemented from SoSField.

   SoType SoSFBox2s::getTypeId (void) const [virtual]
       Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

       See also:
	   getClassTypeId(), SoType

       Implements SoField.

   void SoSFBox2s::copyFrom (const SoField &f) [virtual]
       Copy value(s) from f into this field. f must be of the same type as this field.

       Implements SoField.

   SbBool SoSFBox2s::isSame (const SoField &f) const [virtual]
       Check for equal type and value(s).

       Implements SoField.

   void SoSFBox2s::initClass (void) [static]
       Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

       Reimplemented from SoSField.

   void SoSFBox2s::setValue (shortxmin, shortymin, shortxmax, shortymax)
       Set value of vector.

   void SoSFBox2s::setValue (SbVec2sminvec, SbVec2smaxvec)
       Set value of vector.

   void SoSFBox2s::getValue (SbBox2s &box) const
       Set value of vector.

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

Version 3.1.3							  Wed May 23 2012						      SoSFBox2s(3)