PlaneObject Class Reference
Public Member Functions | |
| PlaneObject () | |
| constructor | |
| PlaneObject (const PlaneObject &_object) | |
| copy constructor | |
| virtual | ~PlaneObject () |
| destructor | |
| virtual void | cleanup () |
| Reset current object, including all related nodes. | |
| BaseObject * | copy () |
Name and Path handling | |
| void | setName (QString _name) |
| Set the name of the Object. | |
Object Information | |
| QString | getObjectinfo () |
| Get all Info for the Object as a string. | |
Picking | |
| bool | picked (uint _node_idx) |
| detect if the node has been picked | |
| void | enablePicking (bool _enable) |
| Enable or disable picking for this Object. | |
| bool | pickingEnabled () |
| Check if picking is enabled for this Object. | |
Protected Member Functions | |
| virtual void | init (PlaneNode *_plane=0) |
| Initialise current object, including all related nodes. | |
Visualization | |
|
| |
| PlaneNode * | planeNode_ |
| PlaneNode * | planeNode () |
| Get the scenegraph Node. | |
Detailed Description
Definition at line 72 of file PlaneObject.hh.
Constructor & Destructor Documentation
| PlaneObject::PlaneObject | ( | ) |
constructor
Constructor for Plane Objects. This object class gets a Separator Node giving the root node to which it should be connected. The plane is generated internally and all nodes for visualization will be added below the scenegraph node.
You dont need to create an object of this type manually. Use the functions from LoadSaveInterface ( addEmpty() )
Definition at line 68 of file PlaneObject.cc.
References BaseObjectData::init(), and BaseObject::setDataType().
Referenced by copy().
| PlaneObject::PlaneObject | ( | const PlaneObject & | _object | ) |
copy constructor
Create a copy of this object
Copy Constructor - generates a copy of the given object
Definition at line 82 of file PlaneObject.cc.
References BaseObjectData::init(), BaseObject::name(), and setName().
| PlaneObject::~PlaneObject | ( | ) | [virtual] |
destructor
Destructor for Plane Objects. The destructor deletes the Line and all Scenegraph nodes associated with the Plane or the object.
Definition at line 94 of file PlaneObject.cc.
References BaseObject::deleteData().
Member Function Documentation
| void PlaneObject::cleanup | ( | void | ) | [virtual] |
Reset current object, including all related nodes.
Cleanup Function for Plane Objects. Deletes the contents of the whole object and calls PlaneObject::init afterwards.
Reimplemented from BaseObjectData.
Definition at line 110 of file PlaneObject.cc.
References BaseObjectData::init(), BaseObject::setDataType(), and setTypeIcon().
| BaseObject * PlaneObject::copy | ( | ) | [virtual] |
return a full copy of this object ( All scenegraph nodes will be created ) but the object will not be a part of the object tree.
Generate a copy
Reimplemented from BaseObject.
Definition at line 126 of file PlaneObject.cc.
References PlaneObject().
| QString PlaneObject::getObjectinfo | ( | ) | [virtual] |
Get all Info for the Object as a string.
Returns a string containing all information about the current object. This also includes the information provided by BaseObjectData::getObjectinfo
- Returns:
- String containing the object information
Reimplemented from BaseObject.
Definition at line 180 of file PlaneObject.cc.
References BaseObject::dataType(), ACG::SceneGraph::PlaneNode::normal(), and ACG::SceneGraph::PlaneNode::position().
| void PlaneObject::init | ( | PlaneNode * | _plane = 0 |
) | [protected, virtual] |
Initialise current object, including all related nodes.
This function initalizes the plane object. It creates the scenegraph nodes.
Definition at line 133 of file PlaneObject.cc.
References BaseObjectData::materialNode(), ACG::SceneGraph::PlaneNode::normal(), ACG::SceneGraph::PlaneNode::position(), ACG::SceneGraph::PlaneNode::setPosition(), ACG::SceneGraph::PlaneNode::setSize(), ACG::SceneGraph::PlaneNode::xDirection(), and ACG::SceneGraph::PlaneNode::yDirection().
| bool PlaneObject::picked | ( | uint | _node_idx | ) | [virtual] |
detect if the node has been picked
Given an node index from PluginFunctions::scenegraphPick this function can be used to check if the planeNode of the object has been picked.
- Parameters:
-
_node_idx Index of the picked plane node
- Returns:
- bool if the planeNode of this object is the picking target.
Reimplemented from BaseObjectData.
Definition at line 209 of file PlaneObject.cc.
References ACG::SceneGraph::ACG::SceneGraph::BaseNode::id().
| void PlaneObject::setName | ( | QString | _name | ) | [virtual] |
Set the name of the Object.
Set the name of an object. All Scenegraph nodes are renamed too. It also calls BaseObjectData::setName.
Reimplemented from BaseObjectData.
Definition at line 156 of file PlaneObject.cc.
References ACG::SceneGraph::ACG::SceneGraph::BaseNode::name().
Referenced by PlaneObject().
The documentation for this class was generated from the following files:
- ObjectTypes/Plane/PlaneObject.hh
- ObjectTypes/Plane/PlaneObject.cc
