Open CASCADE Technology  7.4.1.dev
Public Member Functions
VrmlData_Cylinder Class Reference

#include <VrmlData_Cylinder.hxx>

Inheritance diagram for VrmlData_Cylinder:
Inheritance graph
[legend]

Public Member Functions

 VrmlData_Cylinder ()
 
 VrmlData_Cylinder (const VrmlData_Scene &theScene, const char *theName, const Standard_Real theRadius=1., const Standard_Real theHeight=2.)
 
Standard_Real Radius () const
 
Standard_Real Height () const
 
Standard_Boolean HasBottom () const
 
Standard_Boolean HasSide () const
 
Standard_Boolean HasTop () const
 
void SetRadius (const Standard_Real theRadius)
 
void SetHeight (const Standard_Real theHeight)
 
void SetFaces (const Standard_Boolean hasBottom, const Standard_Boolean hasSide, const Standard_Boolean hasTop)
 
virtual const Handle< TopoDS_TShape > & TShape () override
 
virtual Handle< VrmlData_NodeClone (const Handle< VrmlData_Node > &theOther) const override
 
virtual VrmlData_ErrorStatus Read (VrmlData_InBuffer &theBuffer) override
 
virtual VrmlData_ErrorStatus Write (const char *thePrefix) const override
 
- Public Member Functions inherited from VrmlData_Geometry
 VrmlData_Geometry ()
 
 VrmlData_Geometry (const VrmlData_Scene &theScene, const char *theName)
 
- Public Member Functions inherited from VrmlData_Node
 VrmlData_Node ()
 
virtual ~VrmlData_Node ()
 
const VrmlData_SceneScene () const
 
const char * Name () const
 
VrmlData_ErrorStatus ReadNode (VrmlData_InBuffer &theBuffer, Handle< VrmlData_Node > &theNode, const Handle< Standard_Type > &Type=NULL)
 
virtual Standard_Boolean IsDefault () const
 
VrmlData_ErrorStatus WriteClosing () const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from VrmlData_Node
static VrmlData_ErrorStatus ReadBoolean (VrmlData_InBuffer &theBuffer, Standard_Boolean &theResult)
 
static VrmlData_ErrorStatus ReadString (VrmlData_InBuffer &theBuffer, TCollection_AsciiString &theRes)
 
static VrmlData_ErrorStatus ReadMultiString (VrmlData_InBuffer &theBuffer, NCollection_List< TCollection_AsciiString > &theRes)
 
static VrmlData_ErrorStatus ReadInteger (VrmlData_InBuffer &theBuffer, long &theResult)
 
static Standard_Boolean OK (const VrmlData_ErrorStatus theStat)
 
static Standard_Boolean OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
 
static Standard_Integer GlobalIndent ()
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from VrmlData_Geometry
void SetTShape (const Handle< TopoDS_TShape > &theTShape)
 
void SetModified ()
 
- Protected Member Functions inherited from VrmlData_Node
 VrmlData_Node (const VrmlData_Scene &theScene, const char *theName)
 
- Static Protected Member Functions inherited from VrmlData_Node
static VrmlData_ErrorStatus readBrace (VrmlData_InBuffer &theBuffer)
 
- Protected Attributes inherited from VrmlData_Geometry
Handle< TopoDS_TShapemyTShape
 
Standard_Boolean myIsModified
 

Detailed Description

Implementation of the Cylinder node

Constructor & Destructor Documentation

◆ VrmlData_Cylinder() [1/2]

VrmlData_Cylinder::VrmlData_Cylinder ( )
inline

Empty constructor

◆ VrmlData_Cylinder() [2/2]

VrmlData_Cylinder::VrmlData_Cylinder ( const VrmlData_Scene theScene,
const char *  theName,
const Standard_Real  theRadius = 1.,
const Standard_Real  theHeight = 2. 
)
inline

Constructor

Member Function Documentation

◆ Clone()

virtual Handle< VrmlData_Node > VrmlData_Cylinder::Clone ( const Handle< VrmlData_Node > &  theOther) const
overridevirtual

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.

Reimplemented from VrmlData_Node.

◆ HasBottom()

Standard_Boolean VrmlData_Cylinder::HasBottom ( ) const
inline

Query if the bottom circle is included

◆ HasSide()

Standard_Boolean VrmlData_Cylinder::HasSide ( ) const
inline

Query if the side surface is included

◆ HasTop()

Standard_Boolean VrmlData_Cylinder::HasTop ( ) const
inline

Query if the top surface is included

◆ Height()

Standard_Real VrmlData_Cylinder::Height ( ) const
inline

Query the Height

◆ Radius()

Standard_Real VrmlData_Cylinder::Radius ( ) const
inline

Query the Radius

◆ Read()

virtual VrmlData_ErrorStatus VrmlData_Cylinder::Read ( VrmlData_InBuffer theBuffer)
overridevirtual

Fill the Node internal data from the given input stream.

Implements VrmlData_Node.

◆ SetFaces()

void VrmlData_Cylinder::SetFaces ( const Standard_Boolean  hasBottom,
const Standard_Boolean  hasSide,
const Standard_Boolean  hasTop 
)
inline

Set which faces are included

◆ SetHeight()

void VrmlData_Cylinder::SetHeight ( const Standard_Real  theHeight)
inline

Set the Height

◆ SetRadius()

void VrmlData_Cylinder::SetRadius ( const Standard_Real  theRadius)
inline

Set the Radius

◆ TShape()

virtual const Handle< TopoDS_TShape >& VrmlData_Cylinder::TShape ( )
overridevirtual

Query the primitive topology. This method returns a Null shape if there is an internal error during the primitive creation (zero radius, etc.)

Implements VrmlData_Geometry.

◆ Write()

virtual VrmlData_ErrorStatus VrmlData_Cylinder::Write ( const char *  thePrefix) const
overridevirtual

Write the Node to output stream.

Reimplemented from VrmlData_Node.


The documentation for this class was generated from the following file: