A Coordinate reference frame described in a hierarchical fashion with respect to its parent component. More...

Collaboration diagram for smtk::resource::properties::CoordinateFrame:

Public Member Functions
	CoordinateFrame ()=default
	Allow default constructor.

	CoordinateFrame (const smtk::attribute::ConstGroupItemPtr &groupItem, const std::string &originName="Origin", const std::string &xAxisName="XAxis", const std::string &yAxisName="YAxis", const std::string &zAxisName="ZAxis", const std::string &parentName="Parent")
	Construct CoordinateFrame object from a given GroupItem.

	CoordinateFrame (const smtk::attribute::GroupItemPtr &groupItem, const std::string &originName="Origin", const std::string &xAxisName="XAxis", const std::string &yAxisName="YAxis", const std::string &zAxisName="ZAxis", const std::string &parentName="Parent")

Public Attributes
std::array< double, 3 >	origin { 0, 0, 0 }
	Origin of this frame in parents coordinates.

std::array< double, 3 >	xAxis { 1, 0, 0 }
	X Axis of this frame in parents coordinates.

std::array< double, 3 >	yAxis { 0, 1, 0 }
	Y Axis of this frame in parents coordinates.

std::array< double, 3 >	zAxis { 0, 0, 1 }
	Z Axis of this frame in parents coordinates.

smtk::common::UUID	parent
	Hierarchical parent whose transform should be concatenated, if any. More...

Protected Member Functions
bool	initializeFrom (const smtk::attribute::GroupItem *groupItem, const std::string &originName, const std::string &xAxisName, const std::string &yAxisName, const std::string &zAxisName, const std::string &parentName)

Detailed Description

A Coordinate reference frame described in a hierarchical fashion with respect to its parent component.

Defined by an origin point and 3 axis vectors.

Member Data Documentation

smtk::common::UUID smtk::resource::properties::CoordinateFrame::parent

Hierarchical parent whose transform should be concatenated, if any.

If parent is null, then the coordinate frame transforms to world space.

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

/home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/resource/properties/CoordinateFrame.h
/home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/resource/properties/CoordinateFrame.cxx