← Back to branch summary

~ubuntu-branches/ubuntu/maverick/freecad/maverick

« back to all changes in this revision

Viewing changes to src/Base/BoundBoxPy.xml

  • Committer: Bazaar Package Importer
  • Author(s): Teemu Ikonen
  • Date: 2009-07-16 18:37:41 UTC
  • Revision ID: james.westby@ubuntu.com-20090716183741-oww9kcxqrk991i1n
Tags: upstream-0.8.2237
Import upstream version 0.8.2237

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/Base/BoundBoxPy.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
 
3
  <PythonExport 
 
4
      Father="PyObjectBase" 
 
5
      Name="BoundBoxPy" 
 
6
      Twin="BoundBox" 
 
7
      TwinPointer="BoundBox3d" 
 
8
      Include="Base/BoundBox.h" 
 
9
      FatherInclude="Base/PyObjectBase.h" 
 
10
      Namespace="Base" 
 
11
      Constructor="true"
 
12
      Delete="true" 
 
13
      FatherNamespace="Base">
 
14
    <Documentation>
 
15
      <Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
 
16
      <DeveloperDocu>This is the BoundBox export class</DeveloperDocu>
 
17
      <UserDocu>Bound box class
 
18
A bounding box is an orthographic cube which is a way to describe outer boundaries.
 
19
You get a bounding box from a lot of 3D types. It is often used to check if a 3D
 
20
entity lies in the range of another object. Checking for boundig interference first
 
21
can save a lot of computing time!
 
22
 
 
23
Constructor:
 
24
App.BoundBox([Xmin,Ymin,Zmin,Xmax,Ymax,Zmax])
 
25
App.BoundBox(Tuple, Tuple)
 
26
App.BoundBox(Vector, Vector)
 
27
App.BoundBox(BoundBox)
 
28
          </UserDocu>
 
29
    </Documentation>
 
30
    <Methode Name="add">
 
31
      <Documentation>
 
32
        <UserDocu>method add(BoundBox)
 
33
Add (enlarge) the given BoundBox</UserDocu>
 
34
      </Documentation>
 
35
    </Methode>
 
36
    <Methode Name="isIntersection">
 
37
      <Documentation>
 
38
        <UserDocu>method isIntersection(Vector|BoundBox|Vector Base, Vector Dir)
 
39
Checks if the given object intersects with the BoundBox. That can be:
 
40
- A Vector (Point)
 
41
- Another BoundBox
 
42
- A line, specified by Base and Dir
 
43
                </UserDocu>
 
44
      </Documentation>
 
45
        </Methode>
 
46
        <Methode Name="enlarge">
 
47
                <Documentation>
 
48
                        <UserDocu>method enlarge(Float)
 
49
Enlarge the BoundBox by the given value in each direction.
 
50
A negative value shrinks the box.</UserDocu>
 
51
                </Documentation>
 
52
        </Methode>
 
53
 
 
54
          <Methode Name="getIntersectionPoint">
 
55
                  <Documentation>
 
56
                          <UserDocu>method Vector getIntersectionPoint(Vector Base, Vector Dir)
 
57
Calculate the intersection point of a line with the BoundBox
 
58
                          </UserDocu>
 
59
                  </Documentation>
 
60
          </Methode>
 
61
          <Methode Name="move">
 
62
                  <Documentation>
 
63
                          <UserDocu> method getIntersectionPoint(Vector)
 
64
Move the BoundBox by the given vector
 
65
                          </UserDocu>
 
66
                  </Documentation>
 
67
          </Methode>
 
68
          <Methode Name="isCutPlane">
 
69
      <Documentation>
 
70
        <UserDocu>method bool isCutPlane(Vector Base, Vector Normal)
 
71
Check if the plane specified by Base and Normal intersects (cuts) the BoundBox</UserDocu>
 
72
      </Documentation>
 
73
    </Methode>
 
74
          <Attribute Name="Center" ReadOnly="true">
 
75
                  <Documentation>
 
76
                          <UserDocu>Center point of the bounding box</UserDocu>
 
77
                  </Documentation>
 
78
                  <Parameter Name="Center" Type="Object" />
 
79
          </Attribute>
 
80
          <Attribute Name="XMax" ReadOnly="false">
 
81
                  <Documentation>
 
82
                          <UserDocu>The maximum x boundary position</UserDocu>
 
83
                  </Documentation>
 
84
                  <Parameter Name="XMax" Type="Float" />
 
85
          </Attribute>
 
86
          <Attribute Name="YMax" ReadOnly="false">
 
87
                  <Documentation>
 
88
                          <UserDocu>The maximum y boundary position</UserDocu>
 
89
                  </Documentation>
 
90
                  <Parameter Name="YMax" Type="Float" />
 
91
          </Attribute>
 
92
          <Attribute Name="ZMax" ReadOnly="false">
 
93
                  <Documentation>
 
94
                          <UserDocu>The maximum z boundary position</UserDocu>
 
95
                  </Documentation>
 
96
                  <Parameter Name="ZMax" Type="Float" />
 
97
          </Attribute>
 
98
          <Attribute Name="XMin" ReadOnly="false">
 
99
                  <Documentation>
 
100
                          <UserDocu>The minimum x boundary position</UserDocu>
 
101
                  </Documentation>
 
102
                  <Parameter Name="XMin" Type="Float" />
 
103
          </Attribute>
 
104
          <Attribute Name="YMin" ReadOnly="false">
 
105
                  <Documentation>
 
106
                          <UserDocu>The minimum y boundary position</UserDocu>
 
107
                  </Documentation>
 
108
                  <Parameter Name="YMin" Type="Float" />
 
109
          </Attribute>
 
110
          <Attribute Name="ZMin" ReadOnly="false">
 
111
                  <Documentation>
 
112
                          <UserDocu>The minimum z boundary position</UserDocu>
 
113
                  </Documentation>
 
114
                  <Parameter Name="ZMin" Type="Float" />
 
115
          </Attribute>
 
116
          <Attribute Name="XLength" ReadOnly="true">
 
117
                  <Documentation>
 
118
                          <UserDocu>Length of the BoundBox in x direction</UserDocu>
 
119
                  </Documentation>
 
120
                  <Parameter Name="XLength" Type="Float" />
 
121
          </Attribute>
 
122
          <Attribute Name="YLength" ReadOnly="true">
 
123
                  <Documentation>
 
124
                          <UserDocu>Length of the BoundBox in y direction</UserDocu>
 
125
                  </Documentation>
 
126
                  <Parameter Name="YLength" Type="Float" />
 
127
          </Attribute>
 
128
          <Attribute Name="ZLength" ReadOnly="true">
 
129
                  <Documentation>
 
130
                          <UserDocu>Length of the BoundBox in z direction</UserDocu>
 
131
                  </Documentation>
 
132
                  <Parameter Name="ZLength" Type="Float" />
 
133
          </Attribute>
 
134
          <Attribute Name="DiagonalLength" ReadOnly="true">
 
135
                  <Documentation>
 
136
                          <UserDocu>Diagonal length of the BoundBox</UserDocu>
 
137
                  </Documentation>
 
138
                  <Parameter Name="DiagonalLength" Type="Float" />
 
139
          </Attribute>
 
140
  </PythonExport>
 
141
</GenerateModel>