SphereObject Class Reference

Inheritance diagram for SphereObject:

Public Member Functions
	SphereObject ()
	constructor
	SphereObject (const SphereObject &_object)
	copy constructor
virtual	~SphereObject ()
	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.
Public Member Functions inherited from BaseObjectData
	BaseObjectData (const BaseObjectData &_object)
	copy constructor
	BaseObjectData ()
	constructor
virtual	~BaseObjectData ()
	destructor
virtual void	update (UpdateType _type=UPDATE_ALL)
	This function is called to update the object.
virtual void	show ()
	Sets the whole Scenegraph subtree of this node to visible.
virtual void	hide ()
	Sets the whole Scenegraph subtree of this node to invisible.
virtual bool	visible ()
	return visiblity
virtual void	visible (bool _visible)
	Sets visiblity of the whole Scenegraph subtree of this node.
SeparatorNode *	baseNode ()
virtual bool	hasNode (BaseNode *_node)
	Check if the given node is owned by this object.
virtual BaseNode *	primaryNode ()
QtTranslationManipulatorNode *	manipulatorNode ()
virtual ACG::SceneGraph::ShaderNode *	shaderNode ()
MaterialNode *	materialNode ()
	get a pointer to the materialnode
BoundingBoxNode *	boundingBoxNode ()
	get a pointer to the bounding box node
StencilRefNode *	stencilRefNode ()
	get a pointer to the stencil reference node
bool	manipPlaced ()
	Check if the manipulator has been placed.
void	manipPlaced (bool _placed)
	set the manipulator place status
void	getBoundingBox (ACG::Vec3d &bbmin, ACG::Vec3d &bbmax)
	get the bounding box of the object
void	setObjectDrawMode (const ACG::SceneGraph::DrawModes::DrawMode _mode, bool _force=false)
	Set the draw mode for the object.
template<typename NodeT >
bool	addAdditionalNode (NodeT *_node, QString _pluginName, QString _nodeName, int _id=0)
	add an additional node to the object
bool	hasAdditionalNode (QString _pluginName, QString _nodeName, int _id=0)
	check if an object has the additional node
template<typename NodeT >
bool	getAdditionalNode (NodeT *&_node, QString _pluginName, QString _nodeName, int _id=0)
	get an addition node from the object
template<typename NodeT >
bool	removeAdditionalNode (NodeT *&_node, QString _pluginName, QString _nodeName, int _id=0)
	remove an additional node from the object
Public Member Functions inherited from BaseObject
	BaseObject (const BaseObject &_object)
	BaseObject (BaseObject *_parent=0)
virtual void	printObjectInfo ()
	Print all information about the object.
void	dumpTree ()
	Debugging function, writing the subtree to output.
int	row () const
	get the row of this item from the parent
BaseObject *	parent ()
	Get the parent item ( 0 if rootitem )
void	setParent (BaseObject *_parent)
	Set the parent pointer.
BaseObject *	childExists (int _objectId)
	Check if the element exists in the subtree of this element.
BaseObject *	childExists (QString _name)
	Check if the element exists in the subtree of this element.
void	appendChild (BaseObject *child)
	add a child to this node
BaseObject *	child (int row)
	return a child
int	childCount () const
	get the number of children
void	removeChild (BaseObject *_item)
	Remove a child from this object.
QList< BaseObject * >	getLeafs ()
	get all leafes of the tree below this object ( These will be all visible objects )
void	deleteSubtree ()
	delete the whole subtree below this item ( The item itself is not touched )
int	group ()
bool	isGroup ()
	Check if object is a group.
bool	isInGroup (int _id)
bool	isInGroup (QString _name)
std::vector< int >	getGroupIds ()
QStringList	getGroupNames ()
void	setObjectData (QString _dataName, PerObjectData *_data)
void	clearObjectData (QString _dataName)
	Clear the object data pointer ( this will not delete the object!! )
bool	hasObjectData (QString _dataName)
	Checks if object data with given name is available.
PerObjectData *	objectData (QString _dataName)
	Returns the object data pointer.
void	deleteData ()
	Delete all data attached to this object ( calls delete on each object )
int	id ()
int	persistentId ()
void	persistentId (int _id)
bool	dataType (DataType _type)
DataType	dataType ()
void	setDataType (DataType _type)
bool	target ()
void	target (bool _target)
bool	source ()
void	source (bool _source)
bool	flag (QString _flag)
void	setFlag (QString _flag, bool _set)
QStringList	flags ()
BaseObject *	last ()
BaseObject *	next ()
int	level ()
void	setFromFileName (const QString &_filename)
QString	path ()
	return the path to the object ( defaults to "." if unset )
void	setPath (const QString &_path)
	set the path to the object.
QString	name ()
	return the name of the object. The name defaults to NONAME if unset.
QString	filename ()
	return the filename of the object
void	setFileName (const QString &_filename)
	set the filename for this object
QMap< QString, PerObjectData * > &	getPerObjectDataMap ()
	get reference to map of all perObject Datas

Protected Member Functions
virtual void	init (SphereNode *_sphere=0)
	Initialise current object, including all related nodes.

Visualization
SphereNode *	sphereNode_
	Get the scenegraph Node.
SphereNode *	sphereNode ()
	Get the scenegraph Node.

Additional Inherited Members
Signals inherited from BaseObject
void	objectSelectionChanged (int _objectId)
void	visibilityChanged (int _objectId)
void	objectPropertiesChanged (int _objectId)
Protected Attributes inherited from BaseObject
bool	visible_

Detailed Description

Definition at line 72 of file SphereObject.hh.

Constructor & Destructor Documentation

SphereObject::SphereObject

(

)

constructor

Constructor for Sphere 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 PluginFunctions::addSphere instead. ( see Types.hh::DataType )

Definition at line 68 of file SphereObject.cc.

SphereObject::SphereObject

(

const SphereObject &

_object

)

copy constructor

Create a copy of this object

Copy Constructor - generates a copy of the given object

Definition at line 82 of file SphereObject.cc.

SphereObject::~SphereObject ( )

virtual

destructor

Destructor for Sphere Objects. The destructor deletes the Line and all Scenegraph nodes associated with the Sphere or the object.

Definition at line 94 of file SphereObject.cc.

Member Function Documentation

void SphereObject::cleanup ( void  )

virtual

Reset current object, including all related nodes.

Cleanup Function for Sphere Objects. Deletes the contents of the whole object and calls SphereObject::init afterwards.

Reimplemented from BaseObjectData.

Definition at line 110 of file SphereObject.cc.

BaseObject * SphereObject::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 125 of file SphereObject.cc.

QString SphereObject::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 189 of file SphereObject.cc.

void SphereObject::init ( SphereNode *  _sphere = 0 )

protectedvirtual

Initialise current object, including all related nodes.

This function initalizes the plane object. It creates the scenegraph nodes.

Definition at line 132 of file SphereObject.cc.

bool SphereObject::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 218 of file SphereObject.cc.

void SphereObject::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 165 of file SphereObject.cc.

---

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

• ObjectTypes/Sphere/SphereObject.hh
• ObjectTypes/Sphere/SphereObject.cc