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

A specialized Affine transform that scales along the principal axis the scaling is uniform in the three-directions. More...

#include <Maps.h>

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

Public Types

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

 UniformScaleMap ()
 
 UniformScaleMap (double scale)
 
 UniformScaleMap (const UniformScaleMap &other)
 
 ~UniformScaleMap () 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 UniformScaleMap &other) const
 
bool operator!= (const UniformScaleMap &other) const
 
MapBase::Ptr preTranslate (const Vec3d &) const override
 Return a MapBase::Ptr to a UniformScaleTraslateMap that is the result of pre-translation on this map. More...
 
MapBase::Ptr postTranslate (const Vec3d &) const override
 Return a MapBase::Ptr to a UniformScaleTraslateMap that is the result of post-translation on this map. More...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap
 ScaleMap ()
 
 ScaleMap (const Vec3d &scale)
 
 ScaleMap (const ScaleMap &other)
 
 ~ScaleMap () override=default
 
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 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) and (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) and (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 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 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 UniformScaleMap. More...
 
static bool isRegistered ()
 
static void registerMap ()
 
static Name mapType ()
 
- Static Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap
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 is uniform in the three-directions.

Definition at line 929 of file Maps.h.

Member Typedef Documentation

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap::UniformScaleMap ( )
inline

Definition at line 935 of file Maps.h.

openvdb::OPENVDB_VERSION_NAME::math::UniformScaleMap::UniformScaleMap ( double  scale)
inline

Definition at line 936 of file Maps.h.

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

Definition at line 937 of file Maps.h.

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

Member Function Documentation

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

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap.

Definition at line 943 of file Maps.h.

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

Return a MapBase::Ptr to a new UniformScaleMap.

Definition at line 941 of file Maps.h.

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

Definition at line 945 of file Maps.h.

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

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap.

Definition at line 962 of file Maps.h.

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

Definition at line 951 of file Maps.h.

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

Definition at line 960 of file Maps.h.

Definition at line 965 of file Maps.h.

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

Definition at line 964 of file Maps.h.

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

Return a MapBase::Ptr to a UniformScaleTraslateMap that is the result of post-translation on this map.

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap.

Definition at line 1561 of file Maps.h.

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

Return a MapBase::Ptr to a UniformScaleTraslateMap that is the result of pre-translation on this map.

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap.

Definition at line 1569 of file Maps.h.

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

Definition at line 952 of file Maps.h.

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

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

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::ScaleMap.

Definition at line 959 of file Maps.h.


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