SoComputeBoundingBox(3iv)

1SoComputeBoundingBox(3IV)()                        SoComputeBoundingBox(3IV)()
2
3
4

NAME

6       SoComputeBoundingBox  — computes the bounding box and center of a scene
7       graph
8

INHERITS FROM

10       SoBase > SoFieldContainer > SoEngine > SoComputeBoundingBox
11

SYNOPSIS

13       #include <Inventor/engines/SoComputeBoundingBox.h>
14
15          Inputs from class SoComputeBoundingBox:
16
17     SoSFNode            node
18     SoSFPath            path
19
20          Outputs from class SoComputeBoundingBox:
21
22     (SoSFVec3f)         min
23     (SoSFVec3f)         max
24     (SoSFVec3f)         boxCenter
25     (SoSFVec3f)         objectCenter
26
27          Methods from class SoComputeBoundingBox:
28
29                               SoComputeBoundingBox()
30     void                      setViewportRegion(const        SbViewportRegion
31                                    &vpReg);
32     const SbViewportRegion &  getViewportRegion();
33
34          Methods from class SoEngine:
35
36     static SoType       getClassTypeId()
37     virtual int         getOutputs(SoEngineOutputList &list) const
38     SoEngineOutput *    getOutput(const SbName &outputName) const
39     SbBool              getOutputName(const  SoEngineOutput  *output,  SbName
40                              &outputName) const
41     SoEngine *          copy() const
42     static SoEngine *   getByName(const SbName &name)
43     static int          getByName(const SbName &name, SoEngineList &list)
44
45          Methods from class SoFieldContainer:
46
47     void                setToDefaults()
48     SbBool              hasDefaultValues() const
49     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
50     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
51                              copyConnections = FALSE)
52     SbBool              set(const char *fieldDataString)
53     void                get(SbString &fieldDataString)
54     virtual int         getFields(SoFieldList &resultList) const
55     virtual SoField *   getField(const SbName &fieldName) const
56     SbBool              getFieldName(const SoField *field, SbName &fieldName)
57                              const
58     SbBool              isNotifyEnabled() const
59     SbBool              enableNotify(SbBool flag)
60
61          Methods from class SoBase:
62
63     void                ref()
64     void                unref() const
65     void                unrefNoDelete() const
66     void                touch()
67     virtual SoType      getTypeId() const
68     SbBool              isOfType(SoType type) const
69     virtual void        setName(const SbName &name)
70     virtual SbName      getName() const
71
72

DESCRIPTION

74       This engine computes the bounding box and center of a scene graph.  The
75       scene graph can be defined by a path or by a root node.
76
77       If the path input is not NULL, the bounding box of the graph defined by
78       the path will be computed. If path is NULL, but the node input  is  not
79       NULL,  the bounding box is computed on the graph rooted by the node. By
80       default, the two inputs are NULL. If both the inputs are NULL, the out‐
81       puts are disabled.
82
83       The  engine  uses  a  default  viewport  region.  If the graph includes
84       screen-based objects (such as SoText2) you can call setViewportRegion()
85       on the engine instance to set up the correct viewport region to use.
86

INPUTS

88     SoSFNode            node
89          Defines the graph for which the bounding box is computed.
90
91     SoSFPath            path
92          Alternatively,  defines the graph for which the bounding box is com‐
93          puted.
94
95

OUTPUTS

97     (SoSFVec3f)         min
98          Minimum point of the computed bounding box.
99
100     (SoSFVec3f)         max
101          Maximum point of the computed bounding box.
102
103     (SoSFVec3f)         boxCenter
104          Center of the computed bounding box.
105
106     (SoSFVec3f)         objectCenter
107          Center of the objects in the graph.
108
109

METHODS

111                               SoComputeBoundingBox()
112          Constructor
113
114     void                      setViewportRegion(const        SbViewportRegion
115                                    &vpReg);
116          Sets the viewport region to use for the bounding box computation.
117
118     const SbViewportRegion &  getViewportRegion();
119          Returns the viewport region to use for the bounding box computation.
120
121

FILE FORMAT/DEFAULTS

123       ComputeBoundingBox {
124          node  NULL
125          path  NULL
126     }
127