OpenSim::SimmPoint Class Reference

A class implementing a 3D point. More...

#include <SimmPoint.h>

Inheritance diagram for OpenSim::SimmPoint:

List of all members.

Public Member Functions
	SimmPoint ()
	Default constructor.
	SimmPoint (const SimTK::Vec3 &coords)
	Constructor from a set of XYZ coordinates.
	SimmPoint (const SimmPoint &aPoint)
	Copy constructor.
virtual	~SimmPoint ()
	Destructor.
virtual Object *	copy () const
	Copy this SimmPoint and return a pointer to the copy.
SimmPoint &	operator= (const SimmPoint &aPoint)
	Assignment operator.
SimmPoint &	operator+= (const SimmPoint &aPoint)
	Plus-equals operator.
SimmPoint &	operator/= (double factor)
	Divide-equals operator.
void	set (double x, double y, double z)
	Set the coordinates of the SimmPoint.
SimTK::Vec3 &	get ()
void	scale (double aScaleFactor)
	Scale the XYZ coordinates by a scalar.
bool	isVisible () const
	Is the SimmPoint visible? It is considered invisible if any coordinate is NAN.

---

Detailed Description

A class implementing a 3D point.

Author:

Peter Loan

Version:

1.0

---

Constructor & Destructor Documentation

SimmPoint::SimmPoint

(

)

Default constructor.

SimmPoint::SimmPoint

(

const SimTK::Vec3 &

coords

)

Constructor from a set of XYZ coordinates.

SimmPoint::SimmPoint

(

const SimmPoint &

aPoint

)

Copy constructor.

Parameters:

aPoint

SimmPoint to be copied.

SimmPoint::~SimmPoint

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * SimmPoint::copy

(

)

const [virtual]

Copy this SimmPoint and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this SimmPoint.

Reimplemented from OpenSim::Object.

SimTK::Vec3& OpenSim::SimmPoint::get

(

)

[inline]

bool SimmPoint::isVisible

(

)

const

Is the SimmPoint visible? It is considered invisible if any coordinate is NAN.

Returns:

Whether or not the SimmPoint is visible.

SimmPoint & SimmPoint::operator+=

(

const SimmPoint &

aPoint

)

Plus-equals operator.

Returns:

Reference to this object.

SimmPoint & SimmPoint::operator/=

(

double

factor

)

Divide-equals operator.

Returns:

Reference to this object.

SimmPoint & SimmPoint::operator=

(

const SimmPoint &

aPoint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Object.

void SimmPoint::scale

(

double

aScaleFactor

)

Scale the XYZ coordinates by a scalar.

Parameters:

The

scale factor.

void SimmPoint::set	(	double	x,
		double	y,
		double	z
	)

Set the coordinates of the SimmPoint.

Parameters:

	x	X coordinate
	y	Y coordinate
	z	Z coordinate

---

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

• OpenSim/Common/SimmPoint.h
• OpenSim/Common/SimmPoint.cpp