File: wx.lib.ogl.composit.Constraint.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (112 lines) | stat: -rw-r--r-- 3,762 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.ogl.composit

.. highlight:: python



.. _wx.lib.ogl.composit.Constraint:

==========================================================================================================================================
|phoenix_title|  **wx.lib.ogl.composit.Constraint**
==========================================================================================================================================

The :class:`Constraint` class helps specify how child shapes are laid out
with respect to siblings and parents.



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>Constraint</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.ogl.composit.Constraint_inheritance.png" alt="Inheritance diagram of Constraint" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.ogl.composit.Constraint.html" title="wx.lib.ogl.composit.Constraint" alt="" coords="5,5,216,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.core.Constraint`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.ogl.composit.Constraint.__init__`                                 Default class constructor.
:meth:`~wx.lib.ogl.composit.Constraint.Equals`                                   Return `True` if a and b are approximately equal (for the purposes
:meth:`~wx.lib.ogl.composit.Constraint.Evaluate`                                 Evaluate this constraint and return `True` if anything changed.
:meth:`~wx.lib.ogl.composit.Constraint.SetSpacing`                               Sets the horizontal and vertical spacing for the constraint.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: Constraint(object)

   The :class:`Constraint` class helps specify how child shapes are laid out
   with respect to siblings and parents.

   .. method:: __init__(self, type, constraining, constrained)

      Default class constructor.
      
      :param `type`: see :class:`ConstraintType` for valid types
      :param `constraining`: the constraining :class:`Shape`
      :param `constrained`: the constrained :class:`Shape`


   .. method:: Equals(self, a, b)

      Return `True` if a and b are approximately equal (for the purposes
      of evaluating the constraint).
      
      :param `a`: ???
      :param `b`: ???


   .. method:: Evaluate(self)

      Evaluate this constraint and return `True` if anything changed.


   .. method:: SetSpacing(self, x, y)

      Sets the horizontal and vertical spacing for the constraint.
      
      :param `x`: the x position
      :param `y`: the y position