HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::math::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 <Maps.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::ScaleMap:

Public Types

using Ptr = SharedPtr< ScaleMap >
 
using ConstPtr = SharedPtr< const ScaleMap >
 
- 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

 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. 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 ScaleMap is always linear). More...
 
bool hasUniformScale () const override
 Return true if the values have the same magitude (eg. -1, 1, -1 would be a rotation). 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 of the map applied to in. More...
 
Vec3d applyIJT (const Vec3d &in) const override
 Return the transpose of the inverse Jacobian of the map applied to in. More...
 
Mat3d applyIJC (const Mat3d &in) const override
 Return the Jacobian Curvature: zero for a linear map. More...
 
Mat3d applyIJC (const Mat3d &in, const Vec3d &, const Vec3d &) const override
 
double determinant (const Vec3d &) const override
 Return the product of the scale values, ignores argument. More...
 
double determinant () const override
 Return the product of the scale values. More...
 
const Vec3dgetScale () const
 Return the scale values that define the map. More...
 
const Vec3dgetInvScaleSqr () const
 Return the square of the scale. Used to optimize some finite difference calculations. More...
 
const Vec3dgetInvTwiceScale () const
 Return 1/(2 scale). Used to optimize some finite difference calculations. More...
 
const Vec3dgetInvScale () const
 Return 1/(scale) 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 ScaleMap &other) const
 
bool operator!= (const ScaleMap &other) const
 
AffineMap::Ptr getAffineMap () const override
 Return a AffineMap equivalent to this map. More...
 
Vec3d voxelSize () const override
 Return the lengths of the images of the segments $(0,0,0)-(1,0,0)$, $(0,0,0)-(0,1,0)$, $(0,0,0)-(0,0,1)$. More...
 
Vec3d voxelSize (const Vec3d &) const override
 Return the lengths of the images of the segments $(0,0,0)-(1,0,0)$, $(0,0,0)-(0,1,0)$, $(0,0,0)-(0,0,1)$. 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 appropraite operation to the existing map. More...
 
MapBase::Ptr preTranslate (const Vec3d &) const override
 Return a MapBase::Ptr to a new map that is the result of prepending the appropraite operation to the existing map. More...
 
MapBase::Ptr preScale (const Vec3d &) const override
 Return a MapBase::Ptr to a new map that is the result of prepending the appropraite operation to the existing map. 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 appropraite operation to the existing map. More...
 
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. More...
 
MapBase::Ptr postTranslate (const Vec3d &) const override
 Return a MapBase::Ptr to a new map that is the result of prepending the appropraite operation to the existing map. More...
 
MapBase::Ptr postScale (const Vec3d &) const override
 Return a MapBase::Ptr to a new map that is the result of prepending the appropraite operation to the existing map. 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 prepending the appropraite operation to the existing map. 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 ScaleMap. 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 Affine transform that scales along the principal axis the scaling need not be uniform in the three-directions.

Definition at line 682 of file Maps.h.

Member Typedef Documentation

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::ScaleMap ( )
inline

Definition at line 688 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::ScaleMap ( const Vec3d scale)
inline

Definition at line 692 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::ScaleMap ( const ScaleMap other)
inline

Definition at line 706 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::~ScaleMap ( )
overridedefault

Member Function Documentation

Mat3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::applyIJC ( const Mat3d in) const
inlineoverridevirtual

Return the Jacobian Curvature: zero for a linear map.

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

Definition at line 794 of file Maps.h.

Mat3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::applyIJC ( const Mat3d in,
const Vec3d ,
const Vec3d  
) const
inlineoverridevirtual

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

Definition at line 805 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::applyIJT ( const Vec3d in,
const Vec3d  
) const
inlineoverridevirtual

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

Ignores second argument

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

Definition at line 790 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::applyIJT ( const Vec3d in) const
inlineoverridevirtual

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

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

Definition at line 792 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 775 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 780 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 761 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 769 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 771 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 784 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::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 786 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::applyMap ( const Vec3d in) const
inlineoverridevirtual

Return the image of in under the map.

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

Definition at line 753 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::copy ( void  ) const
inlineoverridevirtual

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

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

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap.

Definition at line 721 of file Maps.h.

static MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::create ( )
inlinestatic

Return a MapBase::Ptr to a new ScaleMap.

Definition at line 719 of file Maps.h.

double openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::determinant ( const Vec3d ) const
inlineoverridevirtual

Return the product of the scale values, ignores argument.

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

Definition at line 809 of file Maps.h.

double openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::determinant ( ) const
inlineoverridevirtual

Return the product of the scale values.

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

Definition at line 811 of file Maps.h.

AffineMap::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::getAffineMap ( ) const
inlineoverridevirtual

Return a AffineMap equivalent to this map.

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

Definition at line 872 of file Maps.h.

const Vec3d& openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::getInvScale ( ) const
inline

Return 1/(scale)

Definition at line 823 of file Maps.h.

const Vec3d& openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::getInvScaleSqr ( ) const
inline

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

Definition at line 819 of file Maps.h.

const Vec3d& openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::getInvTwiceScale ( ) const
inline

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

Definition at line 821 of file Maps.h.

const Vec3d& openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::getScale ( ) const
inline

Return the scale values that define the map.

Definition at line 816 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::hasUniformScale ( ) const
inlineoverridevirtual

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

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

Definition at line 743 of file Maps.h.

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

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap.

Definition at line 723 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::isEqual ( const MapBase other) const
inlineoverridevirtual

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

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

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap.

Definition at line 860 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::isLinear ( ) const
inlineoverridevirtual

Return true (a ScaleMap is always linear).

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

Definition at line 740 of file Maps.h.

static bool openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::isRegistered ( )
inlinestatic

Definition at line 727 of file Maps.h.

static Name openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::mapType ( )
inlinestatic

Definition at line 737 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::operator!= ( const ScaleMap other) const
inline

Definition at line 869 of file Maps.h.

bool openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::operator== ( const ScaleMap other) const
inline

Definition at line 862 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::postRotate ( double  radians,
Axis  axis 
) const
inlineoverridevirtual

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

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

Definition at line 903 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::postScale ( const Vec3d v) const
inlineoverridevirtual

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

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

Definition at line 991 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::postShear ( double  shear,
Axis  axis0,
Axis  axis1 
) const
inlineoverridevirtual

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

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

Definition at line 911 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::postTranslate ( const Vec3d t) const
inlineoverridevirtual

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

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

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap.

Definition at line 1469 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::preRotate ( double  radians,
Axis  axis 
) const
inlineoverridevirtual

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

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

Definition at line 882 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::preScale ( const Vec3d v) const
inlineoverridevirtual

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

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

Definition at line 979 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::preShear ( double  shear,
Axis  axis0,
Axis  axis1 
) const
inlineoverridevirtual

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

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

Definition at line 891 of file Maps.h.

MapBase::Ptr openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::preTranslate ( const Vec3d t) const
inlineoverridevirtual

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

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

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap.

Definition at line 1476 of file Maps.h.

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

read serialization

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

Definition at line 834 of file Maps.h.

static void openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::registerMap ( )
inlinestatic

Definition at line 729 of file Maps.h.

std::string openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::str ( ) const
inlineoverridevirtual

string serialization, useful for debuging

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

Definition at line 852 of file Maps.h.

Name openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::type ( ) const
inlineoverridevirtual

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

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

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap.

Definition at line 736 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::voxelSize ( ) const
inlineoverridevirtual

Return the lengths of the images of the segments $(0,0,0)-(1,0,0)$, $(0,0,0)-(0,1,0)$, $(0,0,0)-(0,0,1)$.

This is equivalent to the absolute values of the scale values

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

Definition at line 829 of file Maps.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::ScaleMap::voxelSize ( const Vec3d ) const
inlineoverridevirtual

Return the lengths of the images of the segments $(0,0,0)-(1,0,0)$, $(0,0,0)-(0,1,0)$, $(0,0,0)-(0,0,1)$.

This is equivalent to the absolute values of the scale values

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

Definition at line 830 of file Maps.h.

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

write serialization

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

Definition at line 843 of file Maps.h.


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