Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample Class Reference

`#include <XformSample.h>`

## Public Member Functions

| XformSample ()
std::size_t | addOp (XformOp iTransOrScaleOp, const Abc::V3d &iVal)
std::size_t | addOp (XformOp iRotateOp, const Abc::V3d &iAxis, const double iAngleInDegrees)
std::size_t | addOp (XformOp iMatrixOp, const Abc::M44d &iMatrix)
std::size_t | addOp (XformOp iSingleRotateOp, const double iSingleAxisRotationInDegrees)
std::size_t | addOp (const XformOp &iOp)
XformOp | getOp (const std::size_t iIndex) const
XformOp & | operator[] (const std::size_t &iIndex)
const XformOp & | operator[] (const std::size_t &iIndex) const
std::size_t | getNumOps () const
std::size_t | getNumOpChannels () const
| The sum of the number of channels of all the ops in this Sample. More...
void | setInheritsXforms (bool iInherits)
bool | getInheritsXforms () const
void | setTranslation (const Abc::V3d &iTrans)
Abc::V3d | getTranslation () const
void | setRotation (const Abc::V3d &iAxis, const double iAngleInDegress)
Abc::V3d | getAxis () const
double | getAngle () const
void | setXRotation (const double iAngleInDegrees)
double | getXRotation () const
void | setYRotation (const double iAngleInDegrees)
double | getYRotation () const
void | setZRotation (const double iAngleInDegrees)
double | getZRotation () const
void | setScale (const Abc::V3d &iScale)
Abc::V3d | getScale () const
void | setMatrix (const Abc::M44d &iMatrix)
Abc::M44d | getMatrix () const
bool | isTopologyEqual (const XformSample &iSample)
| Tests whether this sample has the same topology as iSample. More...
bool | getIsTopologyFrozen () const
| Has this Sample been used in a call to OXformSchema::set() More...
void | reset ()

## Friends

class | OXformSchema
class | IXformSchema

## Detailed Description

Definition at line 50 of file XformSample.h.

## Constructor & Destructor Documentation

## XformSample()

Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::XformSample | ( |  | ) |

## Member Function Documentation

## addOp() [1/5]

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::addOp | ( | const XformOp & | iOp | ) |

## addOp() [2/5]

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::addOp | ( | XformOp | iMatrixOp,
|  | const Abc::M44d & | iMatrix
| ) |  |

## addOp() [3/5]

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::addOp | ( | XformOp | iRotateOp,
|  | const Abc::V3d & | iAxis,
|  | const double | iAngleInDegrees
| ) |  |

## addOp() [4/5]

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::addOp | ( | XformOp | iSingleRotateOp,
|  | const double | iSingleAxisRotationInDegrees
| ) |  |

## addOp() [5/5]

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::addOp | ( | XformOp | iTransOrScaleOp,
|  | const Abc::V3d & | iVal
| ) |  |

## getAngle()

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getAngle | ( |  | ) | const

## getAxis()

Abc::V3d Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getAxis | ( |  | ) | const

## getInheritsXforms()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getInheritsXforms | ( |  | ) | const

## getIsTopologyFrozen()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getIsTopologyFrozen | ( |  | ) | const

inline

Has this Sample been used in a call to OXformSchema::set()

Definition at line 124 of file XformSample.h.

## getMatrix()

Abc::M44d Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getMatrix | ( |  | ) | const

## getNumOpChannels()

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getNumOpChannels | ( |  | ) | const

The sum of the number of channels of all the ops in this Sample.

## getNumOps()

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getNumOps | ( |  | ) | const

## getOp()

XformOp Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getOp | ( | const std::size_t | iIndex | ) | const

## getScale()

Abc::V3d Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getScale | ( |  | ) | const

## getTranslation()

Abc::V3d Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getTranslation | ( |  | ) | const

## getXRotation()

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getXRotation | ( |  | ) | const

## getYRotation()

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getYRotation | ( |  | ) | const

## getZRotation()

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::getZRotation | ( |  | ) | const

## isTopologyEqual()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::isTopologyEqual | ( | const XformSample & | iSample | ) |

Tests whether this sample has the same topology as iSample.

## operator[]() [1/2]

XformOp & Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::operator[] | ( | const std::size_t & | iIndex | ) |

## operator[]() [2/2]

const XformOp & Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::operator[] | ( | const std::size_t & | iIndex | ) | const

## reset()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::reset | ( |  | ) |

## setInheritsXforms()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setInheritsXforms | ( | bool | iInherits | ) |

"Inherits xforms" means, "Does this xform concatenate to or ignore the transforms of its parents?"

## setMatrix()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setMatrix | ( | const Abc::M44d & | iMatrix | ) |

## setRotation()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setRotation | ( | const Abc::V3d & | iAxis,
|  | const double | iAngleInDegress
| ) |  |

## setScale()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setScale | ( | const Abc::V3d & | iScale | ) |

## setTranslation()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setTranslation | ( | const Abc::V3d & | iTrans | ) |

Order matters when calling different setFoo() methods; callstack of methods must be the same for each call to OXformSchmea::set() with a given Sample. For example, a Sample with calls to setTranslation() and setRotation() must make thgose same calls in the same order between each use of OXforSchema::set().

## setXRotation()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setXRotation | ( | const double | iAngleInDegrees | ) |

## setYRotation()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setYRotation | ( | const double | iAngleInDegrees | ) |

## setZRotation()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::XformSample::setZRotation | ( | const double | iAngleInDegrees | ) |

## Friends And Related Function Documentation

## IXformSchema

friend class IXformSchema

friend

Definition at line 130 of file XformSample.h.

## OXformSchema

friend class OXformSchema

friend

Definition at line 129 of file XformSample.h.

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

- opt/local/include/Alembic/AbcGeom/XformSample.h