opal::SpringMotorData Class Reference

A data structure describing a SpringMotor. More...

#include <SpringMotorData.h>

Inheritance diagram for opal::SpringMotorData:

List of all members.

Public Member Functions
OPAL_DECL	SpringMotorData ()
OPAL_DECL	SpringMotorData (const SpringMotorData &data)
virtual OPAL_DECL	~SpringMotorData ()
virtual OPAL_DECL void OPAL_CALL	operator= (const SpringMotorData &data)
Public Attributes
Solid *	solid
int	internal_solidIndex
std::string	solidBlueprintRefName
SpringMotorMode	mode
Point3r	attachOffset
Point3r	desiredPos
Vec3r	desiredForward
Vec3r	desiredUp
Vec3r	desiredRight
real	linearKd
real	linearKs
real	angularKd
real	angularKs

---

Detailed Description

A data structure describing a SpringMotor.

Definition at line 51 of file SpringMotorData.h.

---

Constructor & Destructor Documentation

OPAL_DECL opal::SpringMotorData::SpringMotorData (   )  [inline]

Definition at line 54 of file SpringMotorData.h. References opal::defaults::motor::spring::angularKd, angularKd, opal::defaults::motor::spring::angularKs, angularKs, opal::defaults::motor::spring::desiredForward, desiredForward, opal::defaults::motor::spring::desiredRight, desiredRight, opal::defaults::motor::spring::desiredUp, desiredUp, internal_solidIndex, opal::LINEAR_MODE, opal::defaults::motor::spring::linearKd, linearKd, opal::defaults::motor::spring::linearKs, linearKs, mode, opal::MotorData::mType, solid, solidBlueprintRefName, and opal::SPRING_MOTOR.

OPAL_DECL opal::SpringMotorData::SpringMotorData (  const SpringMotorData &  data  )  [inline]

Copy constructor. Definition at line 74 of file SpringMotorData.h.

virtual OPAL_DECL opal::SpringMotorData::~SpringMotorData (   )  [inline, virtual]

Definition at line 79 of file SpringMotorData.h.

---

Member Function Documentation

virtual OPAL_DECL void OPAL_CALL opal::SpringMotorData::operator= (  const SpringMotorData &  data  )  [inline, virtual]

Makes a deep copy. Definition at line 84 of file SpringMotorData.h. References angularKd, angularKs, attachOffset, desiredForward, desiredPos, desiredRight, desiredUp, opal::MotorData::enabled, internal_solidIndex, linearKd, linearKs, mode, opal::MotorData::mType, opal::MotorData::name, solid, and solidBlueprintRefName.

---

Member Data Documentation

real opal::SpringMotorData::angularKd

The damping constant for angular mode. Definition at line 145 of file SpringMotorData.h. Referenced by opal::SpringMotor::getAngularKd(), operator=(), opal::SpringMotor::setAngularKd(), and SpringMotorData().

real opal::SpringMotorData::angularKs

The spring constant for angular mode. Definition at line 148 of file SpringMotorData.h. Referenced by opal::SpringMotor::getAngularKs(), operator=(), opal::SpringMotor::setAngularKs(), and SpringMotorData().

Point3r opal::SpringMotorData::attachOffset

Local offset (relative to the Solid's position) that defines where the SpringMotor attaches to the Solid. This is only used in linear mode. Definition at line 120 of file SpringMotorData.h. Referenced by opal::SpringMotor::getGlobalAttachPoint(), opal::SpringMotor::getLocalAttachOffset(), opal::SpringMotor::internal_update(), operator=(), opal::SpringMotor::setGlobalAttachPoint(), and opal::SpringMotor::setLocalAttachOffset().

Vec3r opal::SpringMotorData::desiredForward

The Motor's desired forward direction, part of the desired orientation. This is only used if the appropriate mode is set. Definition at line 128 of file SpringMotorData.h. Referenced by operator=(), opal::SpringMotor::setDesiredOrientation(), opal::SpringMotor::setDesiredTransform(), and SpringMotorData().

Point3r opal::SpringMotorData::desiredPos

The Motor's desired position. This is only used if the appropriate mode is set. Definition at line 124 of file SpringMotorData.h. Referenced by opal::SpringMotor::internal_update(), operator=(), opal::SpringMotor::setDesiredPosition(), and opal::SpringMotor::setDesiredTransform().

Vec3r opal::SpringMotorData::desiredRight

The Motor's desired right direction, part of the desired orientation. This is only used if the appropriate mode is set. Definition at line 136 of file SpringMotorData.h. Referenced by operator=(), and SpringMotorData().

Vec3r opal::SpringMotorData::desiredUp

The Motor's desired up direction, part of the desired orientation. This is only used if the appropriate mode is set. Definition at line 132 of file SpringMotorData.h. Referenced by operator=(), and SpringMotorData().

int opal::SpringMotorData::internal_solidIndex

Internal data used for Blueprint instantiation. Definition at line 109 of file SpringMotorData.h. Referenced by operator=(), and SpringMotorData().

real opal::SpringMotorData::linearKd

The damping constant for linear mode. Definition at line 139 of file SpringMotorData.h. Referenced by opal::SpringMotor::getLinearKd(), opal::SpringMotor::internal_update(), operator=(), opal::SpringMotor::setLinearKd(), and SpringMotorData().

real opal::SpringMotorData::linearKs

The spring constant for linear mode. Definition at line 142 of file SpringMotorData.h. Referenced by opal::SpringMotor::getLinearKs(), opal::SpringMotor::internal_update(), operator=(), opal::SpringMotor::setLinearKs(), and SpringMotorData().

SpringMotorMode opal::SpringMotorData::mode

The Motor's mode of operation. Definition at line 115 of file SpringMotorData.h. Referenced by opal::SpringMotor::internal_update(), operator=(), and SpringMotorData().

Solid* opal::SpringMotorData::solid

Pointer to the Solid affected by this Motor. Definition at line 106 of file SpringMotorData.h. Referenced by opal::SpringMotor::getGlobalAttachPoint(), opal::SpringMotor::internal_dependsOnSolid(), opal::SpringMotor::internal_update(), operator=(), opal::SpringMotor::setGlobalAttachPoint(), and SpringMotorData().

std::string opal::SpringMotorData::solidBlueprintRefName

String used for for intra-Blueprint references. Definition at line 112 of file SpringMotorData.h. Referenced by operator=(), and SpringMotorData().

---

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

• SpringMotorData.h

---