summaryrefslogtreecommitdiffstats
path: root/o3d/plugin/idl/draw_element.idl
blob: 3178f86a5aadff836c5d79f53a95c88030d1d7be (plain)
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
/*
 * Copyright 2009, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace o3d {

%[
  A DrawElement causes an Element to be Drawn with a particular material.
  You can override other Effect parameters by adding corresponding params to
  the DrawElement.

  \sa Element
  \sa Material
  \sa Effect

  @o3dparameter material ParamMaterial The material used to render this
      the Element that owns this DrawElement.
%]
[nocpp, include="core/cross/material.h"] class DrawElement
    : ParamObject {

  %[
    The Material for this Draw Element. If it is null the material of owner will
    be used.
  %]
  [getter, setter] Material? material_;

  %[
    The current owner of this Draw Element. Set to null to stop being owned.

    Note: DrawElements are referenced by the Pack they are created in and their
    owner. If the DrawElement is removed from its Pack then setting the owner
    to null will free the DrawElement. Or, visa versa, if you set the
    DrawElement's owner to null then removing it from its Pack will free the
    DrawElement.
  %]
  [getter, setter, userglue_setter] Element? owner_;

  [verbatim=cpp_glue] %{
    void userglue_setter_owner_(
        o3d::DrawElement* _this,
        o3d::Element* owner) {
      _this->SetOwner(owner);
    }
  %}
};  // DrawElement

typedef DrawElement[] DrawElementArray;

}  // namespace o3d