Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

SIGEL_Robot::SIG_Material Class Reference

SIG_Material models properties of the material used to form links. More...

#include <SIG_Material.h>

List of all members.

Public Methods

 SIG_Material (SIG_Robot *par, QString n)
 Kind of a standard constructor. More...

 SIG_Material (SIG_Robot *par, QTextStream & tx)
 Reads the material attributes from a stream. More...

 ~SIG_Material (void)
 Destructor. More...

QString getName (void) const
 Returns the name of the material. More...

void setDensity (DL_Scalar dens)
 Sets the density of the material. More...

DL_Scalar getDensity () const
 Returns the density of the material. More...

void setElasticity (DL_Scalar elas)
 Sets the elasticity value that the corresponding dyna objects should have. More...

DL_Scalar getElasticity () const
 Returns the elasticity of the material. More...

void setColour (DL_vector col)
 Sets the colour of the material. More...

DL_vector getColour () const
 Returns the colour of the material. More...

void setFrictionValue (SIG_Material *otherObj, DL_Scalar fricval, bool negotiate = true)
 setFrictionValue sets or adds a friction constant to the material. More...

DL_Scalar getFrictionValue (SIG_Material *otherObj) const
 Returns the friction constant between this material and the material otherObj. More...

void writeToFileTransfer (QTextStream & tx) const
 Writes the material object into a stream. More...


Private Attributes

SIG_Robotparent
QString name
DL_Scalar elasticity
DL_Scalar density
QList<FrictionValue> friction
DL_vector colour


Detailed Description

SIG_Material models properties of the material used to form links.

Objects instantiated from this class contain information about the density, the elasticity, and the colour of the material.

Definition at line 21 of file SIG_Material.h.


Constructor & Destructor Documentation

SIGEL_Robot::SIG_Material::SIG_Material ( SIG_Robot * par,
QString n )
 

Kind of a standard constructor.

Sets all material values to a default value.

Definition at line 5 of file SIG_Material.cpp.

SIGEL_Robot::SIG_Material::SIG_Material ( SIG_Robot * par,
QTextStream & tx )
 

Reads the material attributes from a stream.

Definition at line 15 of file SIG_Material.cpp.

SIGEL_Robot::SIG_Material::~SIG_Material ( void )
 

Destructor.

Definition at line 41 of file SIG_Material.cpp.


Member Function Documentation

DL_vector SIGEL_Robot::SIG_Material::getColour ( void ) const
 

Returns the colour of the material.

Definition at line 76 of file SIG_Material.cpp.

DL_Scalar SIGEL_Robot::SIG_Material::getDensity ( void ) const
 

Returns the density of the material.

This value denotes the kilograms per cubic meter.

Definition at line 56 of file SIG_Material.cpp.

DL_Scalar SIGEL_Robot::SIG_Material::getElasticity ( void ) const
 

Returns the elasticity of the material.

Please refer to the Dynamo manuals for the interpretation of this value.

Definition at line 66 of file SIG_Material.cpp.

DL_Scalar SIGEL_Robot::SIG_Material::getFrictionValue ( SIG_Material * otherObj ) const
 

Returns the friction constant between this material and the material otherObj.

otherObj->getFrictionValue (this) returns the same value.

Definition at line 105 of file SIG_Material.cpp.

QString SIGEL_Robot::SIG_Material::getName ( void ) const
 

Returns the name of the material.

Definition at line 46 of file SIG_Material.cpp.

void SIGEL_Robot::SIG_Material::setColour ( DL_vector col )
 

Sets the colour of the material.

Definition at line 71 of file SIG_Material.cpp.

void SIGEL_Robot::SIG_Material::setDensity ( DL_Scalar dens )
 

Sets the density of the material.

According to the SI system, this has to be in kilograms per cubic meter.

Definition at line 51 of file SIG_Material.cpp.

void SIGEL_Robot::SIG_Material::setElasticity ( DL_Scalar elas )
 

Sets the elasticity value that the corresponding dyna objects should have.

Please refer to the Dynamo manuals for the interpretation of this value.

Definition at line 61 of file SIG_Material.cpp.

void SIGEL_Robot::SIG_Material::setFrictionValue ( SIG_Material * otherObj,
DL_Scalar fricval,
bool negotiate = true )
 

setFrictionValue sets or adds a friction constant to the material.

Parameters:
otherObj   the opposite material to which the constant will be set
fricval   the actual constant
negotiate   DO NOT TOUCH! If set to true (default) the constant will also be set in the opposite material object.

Definition at line 81 of file SIG_Material.cpp.

void SIGEL_Robot::SIG_Material::writeToFileTransfer ( QTextStream & tx ) const
 

Writes the material object into a stream.

Definition at line 116 of file SIG_Material.cpp.


Member Data Documentation

DL_vector SIGEL_Robot::SIG_Material::colour [private]
 

Definition at line 32 of file SIG_Material.h.

DL_Scalar SIGEL_Robot::SIG_Material::density [private]
 

Definition at line 30 of file SIG_Material.h.

DL_Scalar SIGEL_Robot::SIG_Material::elasticity [private]
 

Definition at line 30 of file SIG_Material.h.

QList< FrictionValue > SIGEL_Robot::SIG_Material::friction [private]
 

Definition at line 31 of file SIG_Material.h.

QString SIGEL_Robot::SIG_Material::name [private]
 

Definition at line 29 of file SIG_Material.h.

SIG_Robot * SIGEL_Robot::SIG_Material::parent [private]
 

Definition at line 28 of file SIG_Material.h.


The documentation for this class was generated from the following files:
Generated at Mon Sep 3 01:32:52 2001 for PG 368 - SIGEL by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000