HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::math::UniformScaleTranslateMap Class Reference

A specialized Affine transform that uniformaly scales along the principal axis and then translates the result. More...

#include <Maps.h>

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

Public Types

using Ptr = SharedPtr< UniformScaleTranslateMap >
 
using ConstPtr = SharedPtr< const UniformScaleTranslateMap >
 
- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap
using Ptr = SharedPtr< ScaleTranslateMap >
 
using ConstPtr = SharedPtr< const ScaleTranslateMap >
 
- 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

 UniformScaleTranslateMap ()
 
 UniformScaleTranslateMap (double scale, const Vec3d &translate)
 
 UniformScaleTranslateMap (const UniformScaleMap &scale, const TranslationMap &translate)
 
 UniformScaleTranslateMap (const UniformScaleTranslateMap &other)
 
 ~UniformScaleTranslateMap () 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 isEqual (const MapBase &other) const override
 Return true if this map is equal to the given map. More...
 
bool operator== (const UniformScaleTranslateMap &other) const
 
bool operator!= (const UniformScaleTranslateMap &other) const
 
MapBase::Ptr preTranslate (const Vec3d &t) const override
 Return a MapBase::Ptr to a UniformScaleTranslateMap that is the result of prepending translation on this map. More...
 
MapBase::Ptr postTranslate (const Vec3d &t) const override
 Return a MapBase::Ptr to a UniformScaleTranslateMap that is the result of postfixing translation on this map. More...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap
 ScaleTranslateMap ()
 
 ScaleTranslateMap (const Vec3d &scale, const Vec3d &translate)
 
 ScaleTranslateMap (const ScaleMap &scale, const TranslationMap &translate)
 
 ScaleTranslateMap (const ScaleTranslateMap &other)
 
 ~ScaleTranslateMap () override=default
 
bool isLinear () const override
 Return true (a ScaleTranslateMap is always linear). More...
 
bool hasUniformScale () const override
 Return true if the scale values have the same magnitude (eg. -1, 1, -1 would be a rotation). More...
 
Vec3d applyMap (const Vec3d &in) const override
 Return the image of under the map. More...
 
Vec3d applyInverseMap (const Vec3d &in) const override
 Return the pre-image of 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...
 
Vec3d voxelSize () const override
 Return the absolute values of the scale values. More...
 
Vec3d voxelSize (const Vec3d &) const override
 Return the absolute values of the scale values, ignores argument. More...
 
const Vec3dgetScale () const
 Returns the scale values. More...
 
const Vec3dgetTranslation () const
 Returns the translation. 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 operator== (const ScaleTranslateMap &other) const
 
bool operator!= (const ScaleTranslateMap &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 appropraite 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 appropraite 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 appropraite 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 appropraite 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 appropraite 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 appropraite 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 UniformScaleTranslateMap. More...
 
static bool isRegistered ()
 
static void registerMap ()
 
static Name mapType ()
 
- Static Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap
static MapBase::Ptr create ()
 Return a MapBase::Ptr to a new ScaleTranslateMap. 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 uniformaly scales along the principal axis and then translates the result.

Definition at line 1492 of file Maps.h.

Member Typedef Documentation

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::math::UniformScaleTranslateMap::UniformScaleTranslateMap ( )
inline

Definition at line 1498 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::UniformScaleTranslateMap::UniformScaleTranslateMap ( double  scale,
const Vec3d translate 
)
inline

Definition at line 1499 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::UniformScaleTranslateMap::UniformScaleTranslateMap ( const UniformScaleMap scale,
const TranslationMap translate 
)
inline

Definition at line 1501 of file Maps.h.

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

Definition at line 1504 of file Maps.h.

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

Member Function Documentation

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

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap.

Definition at line 1510 of file Maps.h.

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

Return a MapBase::Ptr to a new UniformScaleTranslateMap.

Definition at line 1508 of file Maps.h.

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap.

Definition at line 1512 of file Maps.h.

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

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap.

Definition at line 1533 of file Maps.h.

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

Definition at line 1519 of file Maps.h.

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

Definition at line 1531 of file Maps.h.

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

Definition at line 1535 of file Maps.h.

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

Return a MapBase::Ptr to a UniformScaleTranslateMap that is the result of postfixing translation on this map.

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap.

Definition at line 1552 of file Maps.h.

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

Return a MapBase::Ptr to a UniformScaleTranslateMap that is the result of prepending translation on this map.

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap.

Definition at line 1543 of file Maps.h.

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

Definition at line 1524 of file Maps.h.

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

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleTranslateMap.

Definition at line 1530 of file Maps.h.


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