OpenVDB  6.2.1
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 Vec3dgetTranslation () 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

using MapFactory = Ptr (*)(
inherited

Constructor & Destructor Documentation

TranslationMap ( )
inline
TranslationMap ( const Vec3d t)
inline
TranslationMap ( const TranslationMap other)
inline
~TranslationMap ( )
overridedefault

Member Function Documentation

Mat3d applyIJC ( const Mat3d mat) const
inlineoverridevirtual

Return the Jacobian Curvature: zero for a linear map.

Implements MapBase.

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

Implements MapBase.

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.

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.

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.

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.

Vec3d applyInverseMap ( const Vec3d in) const
inlineoverridevirtual

Return the pre-image of in under the map.

Implements MapBase.

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

Return the Jacobian of the map applied to in.

Implements MapBase.

Vec3d applyJacobian ( const Vec3d in) const
inlineoverridevirtual

Return the Jacobian of the map applied to in.

Implements MapBase.

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.

Vec3d applyJT ( const Vec3d in) const
inlineoverridevirtual

Return the Jacobian Transpose of the map applied to in.

Implements MapBase.

Vec3d applyMap ( const Vec3d in) const
inlineoverridevirtual

Return the image of in under the map.

Implements MapBase.

MapBase::Ptr copy ( ) const
inlineoverridevirtual

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

Implements MapBase.

static MapBase::Ptr create ( )
inlinestatic

Return a MapBase::Ptr to a new TranslationMap.

double determinant ( const Vec3d ) const
inlineoverridevirtual

Return 1.

Implements MapBase.

double determinant ( ) const
inlineoverridevirtual

Return 1.

Implements MapBase.

AffineMap::Ptr getAffineMap ( ) const
inlineoverridevirtual

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

Implements MapBase.

const Vec3d& getTranslation ( ) const
inline

Return the translation vector.

bool hasUniformScale ( ) const
inlineoverridevirtual

Return false (by convention true)

Implements MapBase.

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.

bool isEqual ( const MapBase other) const
inlineoverridevirtual

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

Implements MapBase.

static bool isEqualBase ( const MapT &  self,
const MapBase other 
)
inlinestaticprotectedinherited
bool isLinear ( ) const
inlineoverridevirtual

Return true (a TranslationMap is always linear).

Implements MapBase.

static bool isRegistered ( )
inlinestatic
bool isType ( ) const
inlineinherited

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

static Name mapType ( )
inlinestatic
bool operator!= ( const TranslationMap other) const
inline
bool operator== ( const TranslationMap other) const
inline
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.

MapBase::Ptr postScale ( const Vec3d v) const
inlineoverridevirtual

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

Implements MapBase.

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

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

Implements MapBase.

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

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

Implements MapBase.

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.

MapBase::Ptr preScale ( const Vec3d v) const
inlineoverridevirtual

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

Implements MapBase.

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

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

Implements MapBase.

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

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

Implements MapBase.

void read ( std::istream &  is)
inlineoverridevirtual

read serialization

Implements MapBase.

static void registerMap ( )
inlinestatic
std::string str ( ) const
inlineoverridevirtual

string serialization, useful for debuging

Implements MapBase.

Name type ( ) const
inlineoverridevirtual

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

Implements MapBase.

Vec3d voxelSize ( ) const
inlineoverridevirtual

Return (1,1,1).

Implements MapBase.

Vec3d voxelSize ( const Vec3d ) const
inlineoverridevirtual

Return (1,1,1).

Implements MapBase.

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

write serialization

Implements MapBase.


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