OpenVDB 12.0.0
 
Loading...
Searching...
No Matches
TranslationMap Class Referencefinal

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

#include <openvdb/math/Maps.h>

Inheritance diagram for TranslationMap:
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.
 
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 override
 Return true (a TranslationMap is always linear).
 
bool hasUniformScale () const override
 Return false (by convention true)
 
Vec3d applyMap (const Vec3d &in) const override
 Return the image of in under the map.
 
Vec3d applyInverseMap (const Vec3d &in) const override
 Return the pre-image of in under the map.
 
Vec3d applyJacobian (const Vec3d &in, const Vec3d &) const override
 Return the Jacobian of the map applied to in.
 
Vec3d applyJacobian (const Vec3d &in) const override
 Return the Jacobian of the map applied to in.
 
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)
 
Vec3d applyInverseJacobian (const Vec3d &in) const override
 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 override
 Return the Jacobian Transpose of the map applied to in.
 
Vec3d applyJT (const Vec3d &in) const override
 Return the Jacobian Transpose of the map applied to in.
 
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.
 
Vec3d applyIJT (const Vec3d &in) const override
 Return the transpose of the inverse Jacobian (Identity for TranslationMap) of the map applied to in.
 
Mat3d applyIJC (const Mat3d &mat) const override
 Return the Jacobian Curvature: zero for a linear map.
 
Mat3d applyIJC (const Mat3d &mat, const Vec3d &, const Vec3d &) const override
 
double determinant (const Vec3d &) const override
 Return 1.
 
double determinant () const override
 Return 1.
 
Vec3d voxelSize () const override
 Return (1,1,1).
 
Vec3d voxelSize (const Vec3d &) const override
 Return (1,1,1).
 
const Vec3dgetTranslation () const
 Return the translation vector.
 
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 TranslationMap &other) const
 
bool operator!= (const TranslationMap &other) const
 
AffineMap::Ptr getAffineMap () const override
 Return AffineMap::Ptr to an AffineMap equivalent to *this.
 
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.
 
MapBase::Ptr preTranslate (const Vec3d &t) const override
 
MapBase::Ptr preScale (const Vec3d &v) 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 postfixing the appropriate operation.
 
MapBase::Ptr postTranslate (const Vec3d &t) const override
 
MapBase::Ptr postScale (const Vec3d &v) 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 TranslationMap.
 
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

◆ MapFactory

using MapFactory = Ptr (*)()
inherited

◆ Ptr

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 ( )
overridedefault

Member Function Documentation

◆ applyIJC() [1/2]

Mat3d applyIJC ( const Mat3d & mat) const
inlineoverridevirtual

Return the Jacobian Curvature: zero for a linear map.

Implements MapBase.

◆ applyIJC() [2/2]

Mat3d applyIJC ( const Mat3d & mat,
const Vec3d & ,
const Vec3d &  ) const
inlineoverridevirtual

Implements MapBase.

◆ applyIJT() [1/2]

Vec3d applyIJT ( const Vec3d & in) const
inlineoverridevirtual

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

Implements MapBase.

◆ applyIJT() [2/2]

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

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

Implements MapBase.

◆ applyInverseJacobian() [1/2]

Vec3d applyInverseJacobian ( const Vec3d & in) const
inlineoverridevirtual

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
inlineoverridevirtual

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
inlineoverridevirtual

Return the pre-image of in under the map.

Implements MapBase.

◆ applyJacobian() [1/2]

Vec3d applyJacobian ( const Vec3d & in) const
inlineoverridevirtual

Return the Jacobian of the map applied to in.

Implements MapBase.

◆ applyJacobian() [2/2]

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

Return the Jacobian of the map applied to in.

Implements MapBase.

◆ applyJT() [1/2]

Vec3d applyJT ( const Vec3d & in) const
inlineoverridevirtual

Return the Jacobian Transpose of the map applied to in.

Implements MapBase.

◆ applyJT() [2/2]

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

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
inlineoverridevirtual

Return the image of in under the map.

Implements MapBase.

◆ copy()

MapBase::Ptr copy ( ) const
inlineoverridevirtual

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

Implements MapBase.

◆ create()

static MapBase::Ptr create ( )
inlinestatic

Return a MapBase::Ptr to a new TranslationMap.

◆ determinant() [1/2]

double determinant ( ) const
inlineoverridevirtual

Return 1.

Implements MapBase.

◆ determinant() [2/2]

double determinant ( const Vec3d & ) const
inlineoverridevirtual

Return 1.

Implements MapBase.

◆ getAffineMap()

AffineMap::Ptr getAffineMap ( ) const
inlineoverridevirtual

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
inlineoverridevirtual

Return false (by convention true)

Implements MapBase.

◆ inverseMap()

MapBase::Ptr inverseMap ( ) const
inlineoverridevirtual

Return a new map representing the inverse of this map.

Exceptions
NotImplementedErrorif 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
inlineoverridevirtual

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

Implements MapBase.

◆ isEqualBase()

template<typename MapT>
static bool isEqualBase ( const MapT & self,
const MapBase & other )
inlinestaticprotectedinherited

◆ isLinear()

bool isLinear ( ) const
inlineoverridevirtual

Return true (a TranslationMap is always linear).

Implements MapBase.

◆ isRegistered()

static bool isRegistered ( )
inlinestatic

◆ isType()

template<typename MapT>
bool isType ( ) const
inlineinherited

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

◆ mapType()

static Name mapType ( )
inlinestatic

◆ 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
inlineoverridevirtual

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
inlineoverridevirtual

Implements MapBase.

◆ postShear()

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

Implements MapBase.

◆ postTranslate()

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

Implements MapBase.

◆ preRotate()

MapBase::Ptr preRotate ( double radians,
Axis axis ) const
inlineoverridevirtual

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
inlineoverridevirtual

Implements MapBase.

◆ preShear()

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

Implements MapBase.

◆ preTranslate()

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

Implements MapBase.

◆ read()

void read ( std::istream & is)
inlineoverridevirtual

read serialization

Implements MapBase.

◆ registerMap()

static void registerMap ( )
inlinestatic

◆ str()

std::string str ( ) const
inlineoverridevirtual

string serialization, useful for debuging

Implements MapBase.

◆ type()

Name type ( ) const
inlineoverridevirtual

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

Implements MapBase.

◆ voxelSize() [1/2]

Vec3d voxelSize ( ) const
inlineoverridevirtual

Return (1,1,1).

Implements MapBase.

◆ voxelSize() [2/2]

Vec3d voxelSize ( const Vec3d & ) const
inlineoverridevirtual

Return (1,1,1).

Implements MapBase.

◆ write()

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

write serialization

Implements MapBase.