File: Object.hpp

package info (click to toggle)
freefem3d 1.0pre10-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 24,816 kB
  • ctags: 8,361
  • sloc: cpp: 57,201; sh: 8,788; yacc: 2,975; makefile: 1,148; ansic: 508; perl: 110
file content (166 lines) | stat: -rw-r--r-- 3,651 bytes parent folder | download | duplicates (5)
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
//  This file is part of ff3d - http://www.freefem.org/ff3d
//  Copyright (C) 2001, 2002, 2003 Stphane Del Pino

//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2, or (at your option)
//  any later version.

//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.

//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  

//  $Id: Object.hpp,v 1.8 2007/05/20 23:02:48 delpinux Exp $

// This class is defined to allow the use of Objects. Objects are
// made of Shapes which have caracteristics like Boundary Conditions, ...

#ifndef OBJECT_HPP
#define OBJECT_HPP

#include <Shape.hpp>
#include <ReferenceCounting.hpp>

/**
 * @file   Object.hpp
 * @author Stephane Del Pino
 * @date   Sun Aug 31 15:08:43 2003
 * 
 * @brief Describes objects which are made of a shape and maybe a
 * reference
 */
class Object
{
private:
  ConstReferenceCounting<Shape>
  __shape;			/**< the shape */

  bool __hasReference;		/**< true if the object has a reference */

  TinyVector<3,real_t>
  __reference;			/**< the POV-Ray reference of the object */

public:
  /** 
   * Writes the object information in a given stream
   * 
   * @param os the given stream
   * @param o the object to write
   * 
   * @return the modified stream
   */
  friend std::ostream& operator << (std::ostream& os,
				    const Object& o)
  {
    os << (*o.__shape) << '\n';
    return os;
  }

  /** 
   * returns the reference state of the object
   * 
   * @return true if the object has a defined reference
   */
  const bool& hasReference() const
  {
    return __hasReference;
  }

  /** 
   * Access to the reference of the object
   * 
   * @return the reference
   */
  const TinyVector<3>& reference() const
  {
    ASSERT(__hasReference);
    return __reference;
  }

  /** 
   * Read only access to the shape of the object
   * 
   * @return the shape
   */
  ConstReferenceCounting<Shape> shape() const
  {
    ASSERT(__shape != 0);
    return __shape;
  }

  /** 
   * Computes if a vertex is inside the object
   * 
   * @param x the given vertex
   * 
   * @return true if \a x is in the shape
   */
  bool inside(const TinyVector<3, real_t>& x) const
  {
    return __shape->inside(x);
  }

  /** 
   * Sets the reference object
   * 
   * @param aReference the given reference
   */
  void setReference(const TinyVector<3, real_t>& aReference)
  {
    ASSERT(__hasReference == false);
    __hasReference = true;
    __reference = aReference;
  }

  /** 
   * Gets a copy of the Object
   * 
   * @return deep copy of the Object
   */
  ReferenceCounting<Object> getCopy() const
  {
    return new Object(*this);
  }

  /** 
   * Constructs an object using a given shape
   * 
   * @param s the given shape
   */
  Object(ConstReferenceCounting<Shape> s)
    : __shape(s),
      __hasReference(false),
      __reference(0)
  {
    ;
  }

  /** 
   * Constructs an object using another object
   * 
   * @param o a given object
   */
  Object(const Object& o)
    : __shape(o.__shape->getCopy()),
      __hasReference(o.__hasReference),
      __reference(o.__reference)
  {
    ;
  }

  /** 
   * Destructor
   * 
   */
  ~Object()
  {
    ;
  }
};

#endif // OBJECT_HPP