OpenVDB 5.1.0

Public Types | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | List of all members
TranslationMap Class Reference

A specialized linear transform that performs a translation. More...

`#include <Maps.h>`

Inherits MapBase.

## Public Types
using | Ptr = SharedPtr< TranslationMap >
using | ConstPtr = SharedPtr< const TranslationMap >
using | MapFactory = Ptr(*)()

## Public Member Functions
| TranslationMap ()
| TranslationMap (const Vec3d &t)
| TranslationMap (const TranslationMap &other)
| ~TranslationMap () override=default
MapBase::Ptr | copy () const override
| Return a MapBase::Ptr to a deep copy of this map. More...
MapBase::Ptr | inverseMap () const override
| Return a new map representing the inverse of this map. More...
Name | type () const override
| Return the name of this map's concrete type (e.g., `"AffineMap"`). More...
bool | isLinear () const override
| Return `true` (a TranslationMap is always linear). More...
bool | hasUniformScale () const override
| Return `false` (by convention true) More...
Vec3d | applyMap (const Vec3d &in) const override
| Return the image of `in` under the map. More...
Vec3d | applyInverseMap (const Vec3d &in) const override
| Return the pre-image of `in` under the map. More...
Vec3d | applyJacobian (const Vec3d &in, const Vec3d &) const override
| Return the Jacobian of the map applied to in. More...
Vec3d | applyJacobian (const Vec3d &in) const override
| Return the Jacobian of the map applied to in. More...
Vec3d | applyInverseJacobian (const Vec3d &in, const Vec3d &) const override
| Return the Inverse Jacobian of the map applied to in (i.e. inverse map with out translation) More...
Vec3d | applyInverseJacobian (const Vec3d &in) const override
| Return the Inverse Jacobian of the map applied to in (i.e. inverse map with out translation) More...
Vec3d | applyJT (const Vec3d &in, const Vec3d &) const override
| Return the Jacobian Transpose of the map applied to in. More...
Vec3d | applyJT (const Vec3d &in) const override
| Return the Jacobian Transpose of the map applied to in. More...
Vec3d | applyIJT (const Vec3d &in, const Vec3d &) const override
| Return the transpose of the inverse Jacobian (Identity for TranslationMap) of the map applied to `in`, ignores second argument. More...
Vec3d | applyIJT (const Vec3d &in) const override
| Return the transpose of the inverse Jacobian (Identity for TranslationMap) of the map applied to `in`. More...
Mat3d | applyIJC (const Mat3d &mat) const override
| Return the Jacobian Curvature: zero for a linear map. More...
Mat3d | applyIJC (const Mat3d &mat, const Vec3d &, const Vec3d &) const override
double | determinant (const Vec3d &) const override
| Return `1`. More...
double | determinant () const override
| Return `1`. More...
Vec3d | voxelSize () const override
| Return (1,1,1). More...
Vec3d | voxelSize (const Vec3d &) const override
| Return (1,1,1). More...
const Vec3d & | getTranslation () const
| Return the translation vector. More...
void | read (std::istream &is) override
| read serialization More...
void | write (std::ostream &os) const override
| write serialization More...
std::string | str () const override
| string serialization, useful for debuging More...
bool | isEqual (const MapBase &other) const override
| Return `true` if this map is equal to the given map. More...
bool | operator== (const TranslationMap &other) const
bool | operator!= (const TranslationMap &other) const
AffineMap::Ptr | getAffineMap () const override
| Return AffineMap::Ptr to an AffineMap equivalent to *this. More...
template<typename MapT >
bool | isType () const
| Return `true` if this map is of concrete type `MapT` (e.g., AffineMap). More...
MapBase::Ptr | preRotate (double radians, Axis axis) const override
| Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation. More...
MapBase::Ptr | preTranslate (const Vec3d &t) const override
| Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation. More...
MapBase::Ptr | preScale (const Vec3d &v) const override
| Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation. More...
MapBase::Ptr | preShear (double shear, Axis axis0, Axis axis1) const override
| Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation. More...
MapBase::Ptr | postRotate (double radians, Axis axis) const override
| Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation. More...
MapBase::Ptr | postTranslate (const Vec3d &t) const override
| Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation. More...
MapBase::Ptr | postScale (const Vec3d &v) const override
| Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation. More...
MapBase::Ptr | postShear (double shear, Axis axis0, Axis axis1) const override
| Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation. More...

## Static Public Member Functions
static MapBase::Ptr | create ()
| Return a MapBase::Ptr to a new TranslationMap. More...
static bool | isRegistered ()
static void | registerMap ()
static Name | mapType ()

## Static Protected Member Functions
template<typename MapT >
static bool | isEqualBase (const MapT &self, const MapBase &other)

## Detailed Description

A specialized linear transform that performs a translation.

## Member Typedef Documentation

## ◆ ConstPtr

using ConstPtr = SharedPtr<const TranslationMap>

## ◆ MapFactory

using MapFactory = Ptr (*)()
| inherited

## ◆ Ptr

using Ptr = SharedPtr<TranslationMap>

## Constructor & Destructor Documentation

## ◆ TranslationMap() [1/3]

TranslationMap | ( |  | ) |
| inline

## ◆ TranslationMap() [2/3]

TranslationMap | ( | const Vec3d & | t | ) |
| inline

## ◆ TranslationMap() [3/3]

TranslationMap | ( | const TranslationMap & | other | ) |
| inline

## ◆ ~TranslationMap()

~TranslationMap | ( |  | ) |
| override default

## Member Function Documentation

## ◆ applyIJC() [1/2]

Mat3d applyIJC | ( | const Mat3d & | mat | ) | const
| inline override virtual

Return the Jacobian Curvature: zero for a linear map.

Implements MapBase.

## ◆ applyIJC() [2/2]

Mat3d applyIJC | ( | const Mat3d & | mat,
|  | const Vec3d & | ,
|  | const Vec3d & |
| ) |  | const
| inline override virtual

Implements MapBase.

## ◆ applyIJT() [1/2]

Vec3d applyIJT | ( | const Vec3d & | in,
|  | const Vec3d & |
| ) |  | const
| inline override virtual

Return the transpose of the inverse Jacobian (Identity for TranslationMap) of the map applied to `in`, ignores second argument.

Implements MapBase.

## ◆ applyIJT() [2/2]

Vec3d applyIJT | ( | const Vec3d & | in | ) | const
| inline override virtual

Return the transpose of the inverse Jacobian (Identity for TranslationMap) of the map applied to `in`.

Implements MapBase.

## ◆ applyInverseJacobian() [1/2]

Vec3d applyInverseJacobian | ( | const Vec3d & | in,
|  | const Vec3d & |
| ) |  | const
| inline override virtual

Return the Inverse Jacobian of the map applied to in (i.e. inverse map with out translation)

Implements MapBase.

## ◆ applyInverseJacobian() [2/2]

Vec3d applyInverseJacobian | ( | const Vec3d & | in | ) | const
| inline override virtual

Return the Inverse Jacobian of the map applied to in (i.e. inverse map with out translation)

Implements MapBase.

## ◆ applyInverseMap()

Vec3d applyInverseMap | ( | const Vec3d & | in | ) | const
| inline override virtual

Return the pre-image of `in` under the map.

Implements MapBase.

## ◆ applyJacobian() [1/2]

Vec3d applyJacobian | ( | const Vec3d & | in,
|  | const Vec3d & |
| ) |  | const
| inline override virtual

Return the Jacobian of the map applied to in.

Implements MapBase.

## ◆ applyJacobian() [2/2]

Vec3d applyJacobian | ( | const Vec3d & | in | ) | const
| inline override virtual

Return the Jacobian of the map applied to in.

Implements MapBase.

## ◆ applyJT() [1/2]

Vec3d applyJT | ( | const Vec3d & | in,
|  | const Vec3d & |
| ) |  | const
| inline override virtual

Return the Jacobian Transpose of the map applied to in.

This tranforms range-space gradients to domain-space gradients

Implements MapBase.

## ◆ applyJT() [2/2]

Vec3d applyJT | ( | const Vec3d & | in | ) | const
| inline override virtual

Return the Jacobian Transpose of the map applied to in.

Implements MapBase.

## ◆ applyMap()

Vec3d applyMap | ( | const Vec3d & | in | ) | const
| inline override virtual

Return the image of `in` under the map.

Implements MapBase.

## ◆ copy()

MapBase::Ptr copy | ( |  | ) | const
| inline override virtual

Return a MapBase::Ptr to a deep copy of this map.

Implements MapBase.

## ◆ create()

static MapBase::Ptr create | ( |  | ) |
| inline static

Return a MapBase::Ptr to a new TranslationMap.

## ◆ determinant() [1/2]

double determinant | ( | const Vec3d & |  | ) | const
| inline override virtual

Return `1`.

Implements MapBase.

## ◆ determinant() [2/2]

double determinant | ( |  | ) | const
| inline override virtual

Return `1`.

Implements MapBase.

## ◆ getAffineMap()

AffineMap::Ptr getAffineMap | ( |  | ) | const
| inline override virtual

Return AffineMap::Ptr to an AffineMap equivalent to *this.

Implements MapBase.

## ◆ getTranslation()

const Vec3d& getTranslation | ( |  | ) | const
| inline

Return the translation vector.

## ◆ hasUniformScale()

bool hasUniformScale | ( |  | ) | const
| inline override virtual

Return `false` (by convention true)

Implements MapBase.

## ◆ inverseMap()

MapBase::Ptr inverseMap | ( |  | ) | const
| inline override virtual

Return a new map representing the inverse of this map.

Exceptions

  NotImplementedError | if the map is a NonlinearFrustumMap.

Warning
  Houdini 12.5 uses an earlier version of OpenVDB, and maps created with that version lack a virtual table entry for this method. Do not call this method from Houdini 12.5.

Implements MapBase.

## ◆ isEqual()

bool isEqual | ( | const MapBase & | other | ) | const
| inline override virtual

Return `true` if this map is equal to the given map.

Implements MapBase.

## ◆ isEqualBase()

static bool isEqualBase | ( | const MapT & | self,
|  | const MapBase & | other
| ) |  |
| inline static protected inherited

## ◆ isLinear()

bool isLinear | ( |  | ) | const
| inline override virtual

Return `true` (a TranslationMap is always linear).

Implements MapBase.

## ◆ isRegistered()

static bool isRegistered | ( |  | ) |
| inline static

## ◆ isType()

bool isType | ( |  | ) | const
| inline inherited

Return `true` if this map is of concrete type `MapT` (e.g., AffineMap).

## ◆ mapType()

static Name mapType | ( |  | ) |
| inline static

## ◆ operator!=()

bool operator!= | ( | const TranslationMap & | other | ) | const
| inline

## ◆ operator==()

bool operator== | ( | const TranslationMap & | other | ) | const
| inline

## ◆ postRotate()

MapBase::Ptr postRotate | ( | double | radians,
|  | Axis | axis
| ) |  | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation.

Implements MapBase.

## ◆ postScale()

MapBase::Ptr postScale | ( | const Vec3d & | v | ) | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation.

Implements MapBase.

## ◆ postShear()

MapBase::Ptr postShear | ( | double | shear,
|  | Axis | axis0,
|  | Axis | axis1
| ) |  | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation.

Implements MapBase.

## ◆ postTranslate()

MapBase::Ptr postTranslate | ( | const Vec3d & | t | ) | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of postfixing the appropriate operation.

Implements MapBase.

## ◆ preRotate()

MapBase::Ptr preRotate | ( | double | radians,
|  | Axis | axis
| ) |  | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation.

Implements MapBase.

## ◆ preScale()

MapBase::Ptr preScale | ( | const Vec3d & | v | ) | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation.

Implements MapBase.

## ◆ preShear()

MapBase::Ptr preShear | ( | double | shear,
|  | Axis | axis0,
|  | Axis | axis1
| ) |  | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation.

Implements MapBase.

## ◆ preTranslate()

MapBase::Ptr preTranslate | ( | const Vec3d & | t | ) | const
| inline override virtual

Return a MapBase::Ptr to a new map that is the result of prepending the appropriate operation.

Implements MapBase.

## ◆ read()

void read | ( | std::istream & | is | ) |
| inline override virtual

read serialization

Implements MapBase.

## ◆ registerMap()

static void registerMap | ( |  | ) |
| inline static

## ◆ str()

std::string str | ( |  | ) | const
| inline override virtual

string serialization, useful for debuging

Implements MapBase.

## ◆ type()

Name type | ( |  | ) | const
| inline override virtual

Return the name of this map's concrete type (e.g., `"AffineMap"`).

Implements MapBase.

## ◆ voxelSize() [1/2]

Vec3d voxelSize | ( |  | ) | const
| inline override virtual

Return (1,1,1).

Implements MapBase.

## ◆ voxelSize() [2/2]

Vec3d voxelSize | ( | const Vec3d & |  | ) | const
| inline override virtual

Return (1,1,1).

Implements MapBase.

## ◆ write()

void write | ( | std::ostream & | os | ) | const
| inline override virtual

write serialization

Implements MapBase.

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

- Maps.h