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

#include <Maps.h>

Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::TranslationMap:

Public Types
using	Ptr = SharedPtr< TranslationMap >

using	ConstPtr = SharedPtr< const TranslationMap >

Public Types inherited from openvdb::OPENVDB_VERSION_NAME::math::MapBase
using	Ptr = SharedPtr< MapBase >

using	ConstPtr = SharedPtr< const MapBase >

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


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

Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::MapBase
	MapBase (const MapBase &)=default

virtual	~MapBase ()=default

template<typename MapT >
bool	isType () const
	Return `true` if this map is of concrete type `MapT` (e.g., AffineMap). 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 ()

Additional Inherited Members
Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::MapBase
	MapBase ()

Static Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::MapBase
template<typename MapT >
static bool	isEqualBase (const MapT &self, const MapBase &other)

Detailed Description

A specialized linear transform that performs a translation.

Definition at line 977 of file Maps.h.

Member Typedef Documentation

using openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::ConstPtr = SharedPtr<const TranslationMap>

Definition at line 981 of file Maps.h.

using openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::Ptr = SharedPtr<TranslationMap>

Definition at line 980 of file Maps.h.

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::TranslationMap ( )

inline

Definition at line 984 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::TranslationMap ( const Vec3d & t )

inline

Definition at line 985 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::TranslationMap ( const TranslationMap & other )

inline

Definition at line 986 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::~TranslationMap ( )

overridedefault

Member Function Documentation

Mat3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyIJC ( const Mat3d & mat ) const

inlineoverridevirtual

Return the Jacobian Curvature: zero for a linear map.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1049 of file Maps.h.

Mat3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyIJC	(	const Mat3d &	mat,
		const Vec3d &	,
		const Vec3d &
	)		const

inlineoverridevirtual

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1050 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1044 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyIJT ( const Vec3d & in ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1047 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1028 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyInverseJacobian ( const Vec3d & in ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1033 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyInverseMap ( const Vec3d & in ) const

inlineoverridevirtual

Return the pre-image of in under the map.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1020 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyJacobian	(	const Vec3d &	in,
		const Vec3d &
	)		const

inlineoverridevirtual

Return the Jacobian of the map applied to in.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1022 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyJacobian ( const Vec3d & in ) const

inlineoverridevirtual

Return the Jacobian of the map applied to in.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1024 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1038 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyJT ( const Vec3d & in ) const

inlineoverridevirtual

Return the Jacobian Transpose of the map applied to in.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1040 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::applyMap ( const Vec3d & in ) const

inlineoverridevirtual

Return the image of in under the map.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1018 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::copy ( ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 993 of file Maps.h.

static MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::create ( )

inlinestatic

Return a MapBase::Ptr to a new TranslationMap.

Definition at line 991 of file Maps.h.

double openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::determinant ( const Vec3d & ) const

inlineoverridevirtual

Return 1.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1055 of file Maps.h.

double openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::determinant ( ) const

inlineoverridevirtual

Return 1.

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1057 of file Maps.h.

AffineMap::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::getAffineMap ( ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1090 of file Maps.h.

const Vec3d& openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::getTranslation ( ) const

inline

Return the translation vector.

Definition at line 1065 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::hasUniformScale ( ) const

inlineoverridevirtual

Return false (by convention true)

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1015 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::inverseMap ( ) const

inlineoverridevirtual

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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 995 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::isEqual ( const MapBase & other ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1079 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::isLinear ( ) const

inlineoverridevirtual

Return true (a TranslationMap is always linear).

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1012 of file Maps.h.

static bool openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::isRegistered ( )

inlinestatic

Definition at line 999 of file Maps.h.

static Name openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::mapType ( )

inlinestatic

Definition at line 1009 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::operator!= ( const TranslationMap & other ) const

inline

Definition at line 1087 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::operator== ( const TranslationMap & other ) const

inline

Definition at line 1081 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1127 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::postScale ( const Vec3d & v ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1574 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1141 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::postTranslate ( const Vec3d & t ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1134 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1102 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::preScale ( const Vec3d & v ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1563 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::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 openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1116 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::preTranslate ( const Vec3d & t ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1109 of file Maps.h.

void openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::read ( std::istream & is )

inlineoverridevirtual

read serialization

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1068 of file Maps.h.

static void openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::registerMap ( )

inlinestatic

Definition at line 1001 of file Maps.h.

std::string openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::str ( ) const

inlineoverridevirtual

string serialization, useful for debuging

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1072 of file Maps.h.

Name openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::type ( ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1008 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::voxelSize ( ) const

inlineoverridevirtual

Return (1,1,1).

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1060 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::voxelSize ( const Vec3d & ) const

inlineoverridevirtual

Return (1,1,1).

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1062 of file Maps.h.

void openvdb::OPENVDB_VERSION_NAME::math::TranslationMap::write ( std::ostream & os ) const

inlineoverridevirtual

write serialization

Implements openvdb::OPENVDB_VERSION_NAME::math::MapBase.

Definition at line 1070 of file Maps.h.

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

openvdb/math/Maps.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation