Loading...
Searching...
No Matches
ScaleMap Class Reference

A specialized Affine transform that scales along the principal axis the scaling need not be uniform in the three-directions. More...

`#include <openvdb/math/Maps.h>`

Inheritance diagram for ScaleMap:

## Public Types

using | Ptr = SharedPtr<ScaleMap>
using | ConstPtr = SharedPtr<const ScaleMap>
using | MapFactory = Ptr (*)()

## Public Member Functions

| ScaleMap ()
| ScaleMap (const Vec3d &scale)
| ScaleMap (const ScaleMap &other)
| ~ScaleMap () override=default
MapBase::Ptr | copy () const override
| Return a MapBase::Ptr to a deep copy of this map.
MapBase::Ptr | inverseMap () const override
| Return a new map representing the inverse of this map.
Name | type () const override
| Return the name of this map's concrete type (e.g., `"AffineMap"`).
bool | isLinear () const final
| Return `true` (a ScaleMap is always linear).
bool | hasUniformScale () const final
| Return `true` if the values have the same magitude (eg. -1, 1, -1 would be a rotation).
Vec3d | applyMap (const Vec3d &in) const final
| Return the image of `in` under the map.
Vec3d | applyInverseMap (const Vec3d &in) const final
| Return the pre-image of `in` under the map.
Vec3d | applyJacobian (const Vec3d &in, const Vec3d &) const final
| Return the Jacobian of the map applied to in.
Vec3d | applyJacobian (const Vec3d &in) const final
| Return the Jacobian of the map applied to in.
Vec3d | applyInverseJacobian (const Vec3d &in, const Vec3d &) const final
| Return the Inverse Jacobian of the map applied to in (i.e. inverse map with out translation).
Vec3d | applyInverseJacobian (const Vec3d &in) const final
| Return the Inverse Jacobian of the map applied to in (i.e. inverse map with out translation).
Vec3d | applyJT (const Vec3d &in, const Vec3d &) const final
| Return the Jacobian Transpose of the map applied to in.
Vec3d | applyJT (const Vec3d &in) const final
| Return the Jacobian Transpose of the map applied to in.
Vec3d | applyIJT (const Vec3d &in, const Vec3d &) const final
| Return the transpose of the inverse Jacobian of the map applied to in.
Vec3d | applyIJT (const Vec3d &in) const final
| Return the transpose of the inverse Jacobian of the map applied to `in`.
Mat3d | applyIJC (const Mat3d &in) const final
| Return the Jacobian Curvature: zero for a linear map.
Mat3d | applyIJC (const Mat3d &in, const Vec3d &, const Vec3d &) const final
double | determinant (const Vec3d &) const final
| Return the product of the scale values, ignores argument.
double | determinant () const final
| Return the product of the scale values.
const Vec3d & | getScale () const
| Return the scale values that define the map.
const Vec3d & | getInvScaleSqr () const
| Return the square of the scale. Used to optimize some finite difference calculations.
const Vec3d & | getInvTwiceScale () const
| Return 1/(2 scale). Used to optimize some finite difference calculations.
const Vec3d & | getInvScale () const
| Return 1/(scale).
Vec3d | voxelSize () const final
| Return the lengths of the images of the segments (0,0,0) − 1,0,0), (0,0,0) − (0,1,0) and (0,0,0) − (0,0,1).
Vec3d | voxelSize (const Vec3d &) const final
void | read (std::istream &is) override
| read serialization
void | write (std::ostream &os) const override
| write serialization
std::string | str () const override
| string serialization, useful for debuging
bool | isEqual (const MapBase &other) const override
| Return `true` if this map is equal to the given map.
bool | operator== (const ScaleMap &other) const
bool | operator!= (const ScaleMap &other) const
AffineMap::Ptr | getAffineMap () const override
| Return a AffineMap equivalent to this map.
MapBase::Ptr | preRotate (double radians, Axis axis) const override
| Return a MapBase::Ptr to a new map that is the result of prepending the appropraite operation to the existing map.
MapBase::Ptr | preTranslate (const Vec3d &) const override
MapBase::Ptr | preScale (const Vec3d &) const override
MapBase::Ptr | preShear (double shear, Axis axis0, Axis axis1) const override
MapBase::Ptr | postRotate (double radians, Axis axis) const override
| Return a MapBase::Ptr to a new map that is the result of prepending the appropraite operation to the existing map.
MapBase::Ptr | postTranslate (const Vec3d &) const override
MapBase::Ptr | postScale (const Vec3d &) const override
MapBase::Ptr | postShear (double shear, Axis axis0, Axis axis1) const override
template<typename MapT>
bool | isType () const
| Return `true` if this map is of concrete type `MapT` (e.g., AffineMap).

## Static Public Member Functions

static MapBase::Ptr | create ()
| Return a MapBase::Ptr to a new ScaleMap.
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 Affine transform that scales along the principal axis the scaling need not be uniform in the three-directions.

Note
  This class is not marked final because UniformScaleMap inherits from it, so some of the member methods are marked final instead.

## Member Typedef Documentation

## ConstPtr

using ConstPtr = SharedPtr<const ScaleMap>

## MapFactory

using MapFactory = Ptr (*)()

inherited

## Ptr

using Ptr = SharedPtr<ScaleMap>

## Constructor & Destructor Documentation

## ScaleMap() [1/3]

ScaleMap | ( |  | ) |

inline

## ScaleMap() [2/3]

ScaleMap | ( | const Vec3d & | scale | ) |

inline

## ScaleMap() [3/3]

ScaleMap | ( | const ScaleMap & | other | ) |

inline

## ~ScaleMap()

~ScaleMap | ( |  | ) |

override default

## Member Function Documentation

## applyIJC() [1/2]

Mat3d applyIJC | ( | const Mat3d & | in | ) | const

inline final virtual

Return the Jacobian Curvature: zero for a linear map.

Implements MapBase.

## applyIJC() [2/2]

Mat3d applyIJC | ( | const Mat3d & | in,
|  | const Vec3d & | ,
|  | const Vec3d & | ) const

inline final virtual

Implements MapBase.

## applyIJT() [1/2]

Vec3d applyIJT | ( | const Vec3d & | in | ) | const

inline final virtual

Return the transpose of the inverse Jacobian of the map applied to `in`.

Implements MapBase.

## applyIJT() [2/2]

Vec3d applyIJT | ( | const Vec3d & | in,
|  | const Vec3d & | ) const

inline final virtual

Return the transpose of the inverse Jacobian of the map applied to in.

Ignores second argument

Implements MapBase.

## applyInverseJacobian() [1/2]

Vec3d applyInverseJacobian | ( | const Vec3d & | in | ) | const

inline final 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 Vec3d & | ) const

inline final 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 final virtual

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

Implements MapBase.

## applyJacobian() [1/2]

Vec3d applyJacobian | ( | const Vec3d & | in | ) | const

inline final virtual

Return the Jacobian of the map applied to in.

Implements MapBase.

## applyJacobian() [2/2]

Vec3d applyJacobian | ( | const Vec3d & | in,
|  | const Vec3d & | ) const

inline final virtual

Return the Jacobian of the map applied to in.

Implements MapBase.

## applyJT() [1/2]

Vec3d applyJT | ( | const Vec3d & | in | ) | const

inline final virtual

Return the Jacobian Transpose of the map applied to in.

Implements MapBase.

## applyJT() [2/2]

Vec3d applyJT | ( | const Vec3d & | in,
|  | const Vec3d & | ) const

inline final virtual

Return the Jacobian Transpose of the map applied to in.

This tranforms range-space gradients to domain-space gradients

Implements MapBase.

## applyMap()

Vec3d applyMap | ( | const Vec3d & | in | ) | const

inline final 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.

Reimplemented in UniformScaleMap.

## create()

MapBase::Ptr create | ( |  | ) |

inline static

Return a MapBase::Ptr to a new ScaleMap.

## determinant() [1/2]

double determinant | ( |  | ) | const

inline final virtual

Return the product of the scale values.

Implements MapBase.

## determinant() [2/2]

double determinant | ( | const Vec3d & |  | ) | const

inline final virtual

Return the product of the scale values, ignores argument.

Implements MapBase.

## getAffineMap()

AffineMap::Ptr getAffineMap | ( |  | ) | const

inline override virtual

Return a AffineMap equivalent to this map.

Implements MapBase.

## getInvScale()

const Vec3d & getInvScale | ( |  | ) | const

inline

Return 1/(scale).

## getInvScaleSqr()

const Vec3d & getInvScaleSqr | ( |  | ) | const

inline

Return the square of the scale. Used to optimize some finite difference calculations.

## getInvTwiceScale()

const Vec3d & getInvTwiceScale | ( |  | ) | const

inline

Return 1/(2 scale). Used to optimize some finite difference calculations.

## getScale()

const Vec3d & getScale | ( |  | ) | const

inline

Return the scale values that define the map.

## hasUniformScale()

bool hasUniformScale | ( |  | ) | const

inline final virtual

Return `true` if the values have the same magitude (eg. -1, 1, -1 would be a rotation).

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.

Reimplemented in UniformScaleMap.

## isEqual()

bool isEqual | ( | const MapBase & | other | ) | const

inline override virtual

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

Implements MapBase.

Reimplemented in UniformScaleMap.

## isEqualBase()

template<typename MapT>

bool isEqualBase | ( | const MapT & | self,
|  | const MapBase & | other )

inline static protected inherited

## isLinear()

bool isLinear | ( |  | ) | const

inline final virtual

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

Implements MapBase.

## isRegistered()

bool isRegistered | ( |  | ) |

inline static

## isType()

template<typename MapT>

bool isType | ( |  | ) | const

inline inherited

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

## mapType()

Name mapType | ( |  | ) |

inline static

## operator!=()

bool operator!= | ( | const ScaleMap & | other | ) | const

inline

## operator==()

bool operator== | ( | const ScaleMap & | 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 prepending the appropraite operation to the existing map.

Implements MapBase.

## postScale()

MapBase::Ptr postScale | ( | const Vec3d & | v | ) | const

inline override virtual

Implements MapBase.

## postShear()

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

inline override virtual

Implements MapBase.

## postTranslate()

MapBase::Ptr postTranslate | ( | const Vec3d & | t | ) | const

inline override virtual

Implements MapBase.

Reimplemented in UniformScaleMap.

## 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 appropraite operation to the existing map.

Implements MapBase.

## preScale()

MapBase::Ptr preScale | ( | const Vec3d & | v | ) | const

inline override virtual

Implements MapBase.

## preShear()

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

inline override virtual

Implements MapBase.

## preTranslate()

MapBase::Ptr preTranslate | ( | const Vec3d & | t | ) | const

inline override virtual

Implements MapBase.

Reimplemented in UniformScaleMap.

## read()

void read | ( | std::istream & | is | ) |

inline override virtual

read serialization

Implements MapBase.

## registerMap()

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.

Reimplemented in UniformScaleMap.

## voxelSize() [1/2]

Vec3d voxelSize | ( |  | ) | const

inline final virtual

Return the lengths of the images of the segments (0,0,0) − 1,0,0), (0,0,0) − (0,1,0) and (0,0,0) − (0,0,1).

This is equivalent to the absolute values of the scale values

Implements MapBase.

## voxelSize() [2/2]

Vec3d voxelSize | ( | const Vec3d & |  | ) | const

inline final virtual

Implements MapBase.

## write()

void write | ( | std::ostream & | os | ) | const

inline override virtual

write serialization

Implements MapBase.