The Cylinder node specifies a capped cylinder centred at (0,0,0) in the local coordinate system and with a central axis oriented along the local Y-axis. More...
#include <H3D/Cylinder.h>
Classes | |
| class | SFBound |
| SFBound is specialized update itself from the radius and heigh field of the Cylinder node. More... | |
Public Member Functions | |
| Cylinder (Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< SFBool > _bottom=0, Inst< SFFloat > _height=0, Inst< SFFloat > _radius=0, Inst< SFBool > _side=0, Inst< SFBool > _solid=0, Inst< SFBool > _top=0) | |
| Constructor. | |
| ~Cylinder () | |
| Destructor. | |
| virtual void | render () |
| Renders the Cylinder with OpenGL. More... | |
| virtual void | traverseSG (TraverseInfo &ti) |
| Traverse the scenegraph. Adds a HapticCylinder if haptics is enabled. | |
| virtual int | nrTriangles () |
| The number of triangles rendered by this geometry. | |
 Public Member Functions inherited from H3D::X3DGeometryNode | |
| X3DGeometryNode (Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< DisplayList > _displayList=0, Inst< MFBool > _isTouched=0, Inst< MFVec3f > _force=0, Inst< MFVec3f > _contactPoint=0, Inst< MFVec3f > _contactNormal=0, Inst< MFVec3f > _contactTexCoord=0, Inst< SFBoundTree > _boundTree=0, Inst< SFVec3f > _centerOfMass=0) | |
| Constructor. | |
| virtual bool | lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result) |
| Detect intersection between a line segment and this geometry. More... | |
| virtual void | closestPoint (const Vec3f &p, NodeIntersectResult &result) |
| Find closest point on this geometry to point p. More... | |
| virtual bool | movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result) |
| Detect collision between a moving sphere and the geometry. More... | |
| virtual void | glRender () |
| Function overridden from HAPIGLShape. More... | |
| virtual H3DShadowObjectNode * | getShadowObject () |
| Get the H3DShadowObjectNode used to create a shadow volume for this geometry. More... | |
| void | useCulling (bool enabled) |
| This function should be used by the render() function to disable or enable face culling. More... | |
| bool | usingCulling () |
| Returns if face culling is in use or not. | |
| void | allowCulling (bool allow) |
| Control if face culling is allowed or not. More... | |
| void | useBackFaceCulling (bool enabled) |
| Enabling/disabling back face culling. More... | |
| bool | allowingCulling () |
| Returns true if back face culling is allowed, false otherwise. | |
| void | setCullFace (GLenum face) |
| Set which side of a polygon to cull. More... | |
| GLenum | getCullFace () |
| Get which face will be culled if culling is enabled. | |
| template<class OptionNodeType > | |
| void | getOptionNode (OptionNodeType *&option) |
| Get the first option node of the type of the pointer given as argument from the renderOptions fieeld The option argument will contain the node afterwards, or NULL if no option of that type exists. | |
| int | getHapticShapeId (unsigned int index) |
| Get a shape id to be used for rendering of this geometry with HLAPI for the given haptics device. More... | |
| virtual | ~X3DGeometryNode () |
| Destructor. | |
| HAPI::HAPIHapticShape * | getOpenGLHapticShape (unsigned int hd_index, H3DSurfaceNode *_surface, const Matrix4f &_transform, int _nr_vertices=-1) |
| Returns a either a HLFeedbackShape or a HLDepthBufferShape with the X3DGeometryNode. More... | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual bool | supportsTangentAttributes () |
| Returns true if this geometry supports the automatic generation of tangents and binormals as FloatVertexAttribues(needed by e.g. More... | |
| virtual void | getBound (HAPI::Vec3 ¢er, HAPI::Vec3 &size) |
| Overriden from HAPIGLShape to use the bound field in he X3DGeometryNode. More... | |
| virtual void | initialize () |
| Changes behaviour of X3DGeometryNode to be a thread safe RefCountedClass. | |
| Public Member Functions inherited from H3D::X3DChildNode | |
| X3DChildNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DNode | |
| X3DNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| X3DMetadataObject * | getMetadataByName (const string &_name) |
| Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More... | |
| Public Member Functions inherited from H3D::Node | |
| Node () | |
| Constructor. | |
| virtual Node * | clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL) |
| Returns a new instance of this node type with the same state as this one. More... | |
| virtual | ~Node () |
| Destructor. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More... | |
| void | setProtoInstanceParent (X3DPrototypeInstance *p) |
| Set the X3DPrototypeInstance this node is the the root node if applicaple. | |
| virtual Field * | getField (const string &_name) const |
| return a pointer to the field specified by name within this instance | |
| int | addDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| int | removeDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| Public Member Functions inherited from H3D::H3DBoundedObject | |
| H3DBoundedObject (Inst< SFBound > _bound=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::H3DDisplayListObject | |
| H3DDisplayListObject (Inst< DisplayList > _displayList=0) | |
| Constructor. | |
Public Attributes | |
| H3DUniquePtr< SFBool > | bottom |
| Specifies if the bottom of the Cylinder should be rendered or not. More... | |
| H3DUniquePtr< SFFloat > | height |
| The height of the Cylinder in meters. More... | |
| H3DUniquePtr< SFFloat > | radius |
| The radius of the Cylinder. More... | |
| H3DUniquePtr< SFBool > | side |
| Specifies if the sides of the Cylinder should be rendered or not. More... | |
| H3DUniquePtr< SFBool > | solid |
| The solid field determines whether the cylinder is visible when viewed from the inside. More... | |
| H3DUniquePtr< SFBool > | top |
| Specifies if the top of the cylinder should be rendered or not. More... | |
| Public Attributes inherited from H3D::X3DGeometryNode | |
| H3DUniquePtr< MFBool > | isTouched |
| Tells if a HapticsDevice has been in contact with the geometry in the last scenegraph loop. More... | |
| H3DUniquePtr< MFVec3f > | force |
| The last force delivered by this geometry to the haptics device. More... | |
| H3DUniquePtr< MFVec3f > | contactPoint |
| The last contact points of the HapticDevices on the geometry. More... | |
| H3DUniquePtr< MFVec3f > | contactTexCoord |
| The texture coordinate of last the contact points of the HapticDevices on the geometry. More... | |
| H3DUniquePtr< MFVec3f > | contactNormal |
| The normal at the last contact points of the HapticDevices on the geometry. More... | |
| H3DUniquePtr< SFVec3f > | centerOfMass |
| The field contains center of mass for the object, based on its bounding box. More... | |
| H3DUniquePtr< SFBoundTree > | boundTree |
| Contains a tree of the HAPI::GeometryPrimitives that build up the X3DGeometryNode. More... | |
| H3DUniquePtr< MFOptionsNode > | options |
| Contains nodes with options for haptics and graphics rendering. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
| Public Attributes inherited from H3D::H3DBoundedObject | |
| H3DUniquePtr< SFBound > | bound |
| The field containing the bound object. More... | |
| Public Attributes inherited from H3D::H3DDisplayListObject | |
| H3DUniquePtr< DisplayList > | displayList |
| The DisplayList instance handling the OpenGL caching of this object. | |
Protected Attributes | |
| H3DUniquePtr< Field > | vboFieldsUpToDate |
| Internal field used to know if vertex buffer object can be created. More... | |
| Protected Attributes inherited from H3D::X3DGeometryNode | |
| AutoRef< Node > | shadow_volume |
| The shadow volume used for this geometry when shadows enabled. More... | |
| vector< pair< int, pair< Matrix4f, H3DTime > > > | haptic_shape_ids |
| identifiers for the shapes geometry. | |
Additional Inherited Members | |
| Public Types inherited from H3D::Node | |
| typedef std::map< Node *, Node * > | DeepCopyMap |
| A map type used during a deep copy clone() to map from original nodes to cloned nodes. | |
| Static Public Member Functions inherited from H3D::Node | |
| static unsigned int | nrNodesAlive () |
| Returns the nr of nodes currently alive, i.e. nodes created but not destructed. | |
| static int | nrNodesCreated () |
| Returns the number of nodes created in total since the start of the program. | |
| Static Public Attributes inherited from H3D::X3DGeometryNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Protected Member Functions inherited from H3D::Node | |
| void | cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for the clone() method. More... | |
| Static Protected Member Functions inherited from H3D::X3DGeometryNode | |
| static void | cleanUpFunction (void *userdata) |
| Function sent to HAPIHapticsShape created to allow for deletion of X3DGeometryNode at the correct time. More... | |
| Static Protected Member Functions inherited from H3D::Node | |
| static Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
The Cylinder node specifies a capped cylinder centred at (0,0,0) in the local coordinate system and with a central axis oriented along the local Y-axis.
By default, the cylinder is sized at "-1" to "+1" in all three dimensions. The radius field specifies the radius of the cylinder and the height field specifies the height of the cylinder along the central axis. Both radius and height shall be greater than zero.
The cylinder has three parts: the side, the top (Y = +height/2) and the bottom (Y = -height/2). Each part has an associated SFBool field that indicates whether the part exists (TRUE) or does not exist (FALSE). Parts which do not exist are not rendered and not eligible for intersection tests (EXAMPLE collision detection or sensor activation).
When a texture is applied to a cylinder, it is applied differently to the sides, top, and bottom. On the sides, the texture wraps counterclockwise (from above) starting at the back of the cylinder. The texture has a vertical seam at the back, intersecting the X=0 plane. For the top and bottom caps, a circle is cut out of the unit texture squares centred at (0, +-height/2, 0) with dimensions 2 X radius by 2 X radius. The top texture appears right side up when the top of the cylinder is tilted toward the +Z-axis, and the bottom texture appears right side up when the top of the cylinder is tilted toward the Z-axis. TextureTransform affects the texture coordinates of the Cylinder node.
The solid field determines whether the cylinder is visible when viewed from the inside. If solid is false both sides of the cylinder will be rendered.
Examples:
- Cylinder.x3d ( Source )
- Internal routes:
Member Function Documentation
◆ render()
|
virtual |
Renders the Cylinder with OpenGL.
Create side vertices.
Reimplemented from H3D::Node.
References angle, bottom, H3D::X3DTextureCoordinateNode::disableVBOForActiveTexture(), H3D::GlobalSettings::getActive(), H3D::GlobalSettings::getOptionNode(), H3D::X3DGeometryNode::getOptionNode(), height, H3D::GraphicsOptions::preferVertexBufferObject, radius, H3D::Node::render(), H3D::X3DTextureCoordinateNode::renderVertexBufferObjectForActiveTexture(), side, top, and vboFieldsUpToDate.
Member Data Documentation
◆ bottom
| H3DUniquePtr< SFBool > H3D::Cylinder::bottom |
Specifies if the bottom of the Cylinder should be rendered or not.
Access type: inputOutput
Default value: TRUE
Referenced by Cylinder(), and render().
◆ height
| H3DUniquePtr< SFFloat > H3D::Cylinder::height |
The height of the Cylinder in meters.
Access type: inputOutput
Default value: 2
Valid range: >0
Referenced by Cylinder(), and render().
◆ radius
| H3DUniquePtr< SFFloat > H3D::Cylinder::radius |
The radius of the Cylinder.
Access type: inputOutput
Default value: 1
Valid range: >0
Referenced by Cylinder(), and render().
◆ side
| H3DUniquePtr< SFBool > H3D::Cylinder::side |
Specifies if the sides of the Cylinder should be rendered or not.
Access type: inputOutput
Default value: TRUE
Referenced by Cylinder(), and render().
◆ solid
| H3DUniquePtr< SFBool > H3D::Cylinder::solid |
The solid field determines whether the cylinder is visible when viewed from the inside.
If solid is false both sides of the sphere will be rendered.
Access type: inputOutput
Default value: TRUE
Referenced by Cylinder(), and traverseSG().
◆ top
| H3DUniquePtr< SFBool > H3D::Cylinder::top |
Specifies if the top of the cylinder should be rendered or not.
Access type: inputOutput
Default value: TRUE
Referenced by Cylinder(), and render().
◆ vboFieldsUpToDate
|
protected |
Internal field used to know if vertex buffer object can be created.
C++ only field
Referenced by Cylinder(), and render().
The documentation for this class was generated from the following files:
