summaryrefslogtreecommitdiff
path: root/inc/VrmlData_Cone.hxx
blob: 607ea2ff11c9a81f5abad87e6da14b2231ec1324 (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
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
// File:      VrmlData_Cone.hxx
// Created:   25.05.06 17:29:32
// Author:    Alexander GRIGORIEV
// Copyright: Open Cascade 2006


#ifndef VrmlData_Cone_HeaderFile
#define VrmlData_Cone_HeaderFile

#include <VrmlData_Geometry.hxx>

/**
 *  Implementation of the Cone node.
 *  The cone is located with its middle of the height segment in (0., 0., 0.) 
 *  The height is oriented along OY.
 */
class VrmlData_Cone : public VrmlData_Geometry
{
 public:
  // ---------- PUBLIC METHODS ----------

  /**
   * Empty constructor
   */
  inline VrmlData_Cone ()
    : myBottomRadius    (1.),
      myHeight          (2.),
      myHasSide         (Standard_True),
      myHasBottom       (Standard_True)
  {}

  /**
   * Constructor
   */
  inline VrmlData_Cone (const VrmlData_Scene&   theScene,
                        const char              * theName,
                        const Standard_Real     theBottomRadius = 1.,
                        const Standard_Real     theHeight = 2.)
    : VrmlData_Geometry (theScene, theName),
      myBottomRadius    (theBottomRadius),
      myHeight          (theHeight),
      myHasSide         (Standard_True),
      myHasBottom       (Standard_True)
  {}

  /**
   * Query the Bottom Radius
   */
  inline Standard_Real    BottomRadius  () const    { return myBottomRadius; }

  /**
   * Query the Height
   */
  inline Standard_Real    Height        () const    { return myHeight; }

  /**
   * Query if the bottom circle is included
   */
  inline Standard_Boolean HasBottom     () const    { return myHasBottom; }

  /**
   * Query if the side surface is included
   */
  inline Standard_Boolean HasSide       () const    { return myHasSide; }

  /**
   * Set the Bottom Radius
   */
  inline void             SetBottomRadius (const Standard_Real theRadius)
  { myBottomRadius = theRadius; SetModified(); }

  /**
   * Set the Height
   */
  inline void             SetHeight     (const Standard_Real theHeight)
  { myHeight = theHeight; SetModified(); }

  /**
   * Set which faces are included
   */
  inline void             SetFaces      (const Standard_Boolean hasBottom,
                                         const Standard_Boolean hasSide)
  { myHasBottom = hasBottom; myHasSide = hasSide; SetModified(); }

  /**
   * Query the primitive topology. This method returns a Null shape if there
   * is an internal error during the primitive creation (zero radius, etc.)
   */
  Standard_EXPORT virtual const Handle(TopoDS_TShape)&  TShape ();

  /**
   * Create a copy of this node.
   * If the parameter is null, a new copied node is created. Otherwise new node
   * is not created, but rather the given one is modified.
   */
  Standard_EXPORT virtual Handle(VrmlData_Node)
                        Clone   (const Handle(VrmlData_Node)& theOther) const;

  /**
   * Fill the Node internal data from the given input stream.
   */
  Standard_EXPORT virtual VrmlData_ErrorStatus
                        Read    (VrmlData_InBuffer& theBuffer);

  /**
   * Write the Node to output stream.
   */
  Standard_EXPORT virtual VrmlData_ErrorStatus
                        Write   (const char * thePrefix) const;


 protected:
  // ---------- PROTECTED METHODS ----------



 private:
  // ---------- PRIVATE FIELDS ----------

  Standard_Real         myBottomRadius;
  Standard_Real         myHeight;
  Standard_Boolean      myHasSide       : 1;
  Standard_Boolean      myHasBottom     : 1;


 public:
// Declaration of CASCADE RTTI
DEFINE_STANDARD_RTTI (VrmlData_Cone)
};

// Definition of HANDLE object using Standard_DefineHandle.hxx
DEFINE_STANDARD_HANDLE (VrmlData_Cone, VrmlData_Geometry)


#endif