Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample Class Reference

`#include <OCurves.h>`

Collaboration diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample:
[legend]

## Public Member Functions

| Sample ()
| Sample (const Abc::P3fArraySample &iPos)

Sample (const Abc::P3fArraySample &iPos, const Abc::Int32ArraySample &iNVertices, const CurveType &iType=kCubic, const CurvePeriodicity iWrap=kNonPeriodic, const OFloatGeomParam::Sample &iWidths=OFloatGeomParam::Sample(), const OV2fGeomParam::Sample &iUVs=OV2fGeomParam::Sample(), const ON3fGeomParam::Sample &iNormals=ON3fGeomParam::Sample(), const BasisType &iBasis=kBezierBasis, const Abc::FloatArraySample &iPosWeight=Abc::FloatArraySample(), const Abc::UcharArraySample &iOrders=Abc::UcharArraySample(), const Abc::FloatArraySample &iKnots=Abc::FloatArraySample())

const OFloatGeomParam::Sample & | getWidths () const
void | setWidths (const OFloatGeomParam::Sample &iWidths)
const Abc::P3fArraySample & | getPositions () const
void | setPositions (const Abc::P3fArraySample &iSmp)
const Abc::FloatArraySample & | getPositionWeights () const
void | setPositionWeights (const Abc::FloatArraySample &iSmp)
void | setType (const CurveType &iType)
CurveType | getType () const
void | setWrap (const CurvePeriodicity &iWrap)
CurvePeriodicity | getWrap () const
std::size_t | getNumCurves () const
void | setCurvesNumVertices (const Abc::Int32ArraySample &iNVertices)
const Abc::Int32ArraySample & | getCurvesNumVertices () const
const OV2fGeomParam::Sample & | getUVs () const
void | setUVs (const OV2fGeomParam::Sample &iUVs)
const Abc::Box3d & | getSelfBounds () const
void | setSelfBounds (const Abc::Box3d &iBnds)
const Abc::V3fArraySample & | getVelocities () const
void | setVelocities (const Abc::V3fArraySample &iVelocities)
const ON3fGeomParam::Sample & | getNormals () const
void | setNormals (const ON3fGeomParam::Sample &iNormals)
BasisType | getBasis () const
void | setBasis (const BasisType &iBasis)
const Abc::UcharArraySample & | getOrders () const
void | setOrders (const Abc::UcharArraySample &iOrders)
const Abc::FloatArraySample & | getKnots () const
void | setKnots (const Abc::FloatArraySample &iKnots)
void | reset ()
bool | isPartialSample () const

## Protected Attributes

Abc::P3fArraySample | m_positions
Abc::V3fArraySample | m_velocities
Abc::Int32ArraySample | m_nVertices
CurveType | m_type
CurvePeriodicity | m_wrap
OFloatGeomParam::Sample | m_widths
OV2fGeomParam::Sample | m_uvs
ON3fGeomParam::Sample | m_normals
BasisType | m_basis
Abc::FloatArraySample | m_positionWeights
Abc::UcharArraySample | m_orders
Abc::FloatArraySample | m_knots
Abc::Box3d | m_selfBounds

## Detailed Description

Definition at line 68 of file OCurves.h.

## Constructor & Destructor Documentation

## Sample() [1/3]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::Sample | ( |  | ) |

inline

Creates a default sample with no data in it. ...

Definition at line 73 of file OCurves.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::kBezierBasis, Alembic::AbcGeom::ALEMBIC_VERSION_NS::kCubic, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::kNonPeriodic.

## Sample() [2/3]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::Sample | ( | const Abc::P3fArraySample & | iPos | ) |

inline

Creates a sample with position data but no index or count data. For specifying samples after the first one

Definition at line 86 of file OCurves.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::kBezierBasis, Alembic::AbcGeom::ALEMBIC_VERSION_NS::kCubic, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::kNonPeriodic.

## Sample() [3/3]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::Sample | ( | const Abc::P3fArraySample & | iPos,
|  | const Abc::Int32ArraySample & | iNVertices,
|  | const CurveType & | iType = `kCubic`,
|  | const CurvePeriodicity | iWrap = `kNonPeriodic`,
|  | const OFloatGeomParam::Sample & | iWidths = `OFloatGeomParam::Sample()`,
|  | const OV2fGeomParam::Sample & | iUVs = `OV2fGeomParam::Sample()`,
|  | const ON3fGeomParam::Sample & | iNormals = `ON3fGeomParam::Sample()`,
|  | const BasisType & | iBasis = `kBezierBasis`,
|  | const Abc::FloatArraySample & | iPosWeight = `Abc::FloatArraySample()`,
|  | const Abc::UcharArraySample & | iOrders = `Abc::UcharArraySample()`,
|  | const Abc::FloatArraySample & | iKnots = `Abc::FloatArraySample()`
| ) |  |

inline

Creates a sample with position data, index data, count data, and optional UV and Normals data. For specifying samples with an explicit topology. The first sample must be full like this. Subsequent samples may also be full like this, which would indicate a change of topology

Definition at line 103 of file OCurves.h.

## Member Function Documentation

## getBasis()

BasisType Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getBasis | ( |  | ) | const

inline

Definition at line 185 of file OCurves.h.

## getCurvesNumVertices()

const Abc::Int32ArraySample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getCurvesNumVertices | ( |  | ) | const

inline

Definition at line 161 of file OCurves.h.

## getKnots()

const Abc::FloatArraySample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getKnots | ( |  | ) | const

inline

Definition at line 195 of file OCurves.h.

## getNormals()

const ON3fGeomParam::Sample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getNormals | ( |  | ) | const

inline

Definition at line 180 of file OCurves.h.

## getNumCurves()

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getNumCurves | ( |  | ) | const

inline

Definition at line 155 of file OCurves.h.

## getOrders()

const Abc::UcharArraySample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getOrders | ( |  | ) | const

inline

Definition at line 190 of file OCurves.h.

## getPositions()

const Abc::P3fArraySample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getPositions | ( |  | ) | const

inline

Definition at line 135 of file OCurves.h.

## getPositionWeights()

const Abc::FloatArraySample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getPositionWeights | ( |  | ) | const

inline

Definition at line 140 of file OCurves.h.

## getSelfBounds()

const Abc::Box3d & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getSelfBounds | ( |  | ) | const

inline

Definition at line 170 of file OCurves.h.

## getType()

CurveType Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getType | ( |  | ) | const

inline

Definition at line 148 of file OCurves.h.

## getUVs()

const OV2fGeomParam::Sample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getUVs | ( |  | ) | const

inline

Definition at line 165 of file OCurves.h.

## getVelocities()

const Abc::V3fArraySample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getVelocities | ( |  | ) | const

inline

Definition at line 175 of file OCurves.h.

## getWidths()

const OFloatGeomParam::Sample & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getWidths | ( |  | ) | const

inline

Definition at line 130 of file OCurves.h.

## getWrap()

CurvePeriodicity Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::getWrap | ( |  | ) | const

inline

Definition at line 153 of file OCurves.h.

## isPartialSample()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::isPartialSample | ( |  | ) | const

inline

Definition at line 220 of file OCurves.h.

## reset()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::reset | ( |  | ) |

inline

Definition at line 199 of file OCurves.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::kBezierBasis, Alembic::AbcGeom::ALEMBIC_VERSION_NS::kCubic, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::kNonPeriodic.

## setBasis()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setBasis | ( | const BasisType & | iBasis | ) |

inline

Definition at line 186 of file OCurves.h.

## setCurvesNumVertices()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setCurvesNumVertices | ( | const Abc::Int32ArraySample & | iNVertices | ) |

inline

an array of ints that corresponds to the number of vertices per curve

Definition at line 159 of file OCurves.h.

## setKnots()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setKnots | ( | const Abc::FloatArraySample & | iKnots | ) |

inline

Definition at line 196 of file OCurves.h.

## setNormals()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setNormals | ( | const ON3fGeomParam::Sample & | iNormals | ) |

inline

Definition at line 181 of file OCurves.h.

## setOrders()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setOrders | ( | const Abc::UcharArraySample & | iOrders | ) |

inline

Definition at line 191 of file OCurves.h.

## setPositions()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setPositions | ( | const Abc::P3fArraySample & | iSmp | ) |

inline

Definition at line 136 of file OCurves.h.

## setPositionWeights()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setPositionWeights | ( | const Abc::FloatArraySample & | iSmp | ) |

inline

Definition at line 142 of file OCurves.h.

## setSelfBounds()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setSelfBounds | ( | const Abc::Box3d & | iBnds | ) |

inline

Definition at line 171 of file OCurves.h.

## setType()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setType | ( | const CurveType & | iType | ) |

inline

Definition at line 146 of file OCurves.h.

## setUVs()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setUVs | ( | const OV2fGeomParam::Sample & | iUVs | ) |

inline

Definition at line 166 of file OCurves.h.

## setVelocities()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setVelocities | ( | const Abc::V3fArraySample & | iVelocities | ) |

inline

Definition at line 176 of file OCurves.h.

## setWidths()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setWidths | ( | const OFloatGeomParam::Sample & | iWidths | ) |

inline

Definition at line 131 of file OCurves.h.

## setWrap()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::setWrap | ( | const CurvePeriodicity & | iWrap | ) |

inline

Definition at line 151 of file OCurves.h.

## Member Data Documentation

## m_basis

BasisType Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_basis

protected

Definition at line 247 of file OCurves.h.

## m_knots

Abc::FloatArraySample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_knots

protected

Definition at line 252 of file OCurves.h.

## m_normals

ON3fGeomParam::Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_normals

protected

Definition at line 245 of file OCurves.h.

## m_nVertices

Abc::Int32ArraySample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_nVertices

protected

Definition at line 238 of file OCurves.h.

## m_orders

Abc::UcharArraySample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_orders

protected

Definition at line 251 of file OCurves.h.

## m_positions

Abc::P3fArraySample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_positions

protected

Definition at line 236 of file OCurves.h.

## m_positionWeights

Abc::FloatArraySample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_positionWeights

protected

Definition at line 250 of file OCurves.h.

## m_selfBounds

Abc::Box3d Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_selfBounds

protected

Definition at line 255 of file OCurves.h.

## m_type

CurveType Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_type

protected

Definition at line 240 of file OCurves.h.

## m_uvs

OV2fGeomParam::Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_uvs

protected

Definition at line 244 of file OCurves.h.

## m_velocities

Abc::V3fArraySample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_velocities

protected

Definition at line 237 of file OCurves.h.

## m_widths

OFloatGeomParam::Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_widths

protected

Definition at line 243 of file OCurves.h.

## m_wrap

CurvePeriodicity Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCurvesSchema::Sample::m_wrap

protected

Definition at line 241 of file OCurves.h.

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

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