OpenVDB  6.2.1
Public Types | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | List of all members
UniformScaleTranslateMap Class Reference

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

#include <Maps.h>

Inherits ScaleTranslateMap.

Public Types

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

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 Protected Member Functions

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.

Member Typedef Documentation

using MapFactory = Ptr (*)(
inherited

Constructor & Destructor Documentation

UniformScaleTranslateMap ( double  scale,
const Vec3d translate 
)
inline
UniformScaleTranslateMap ( const UniformScaleMap scale,
const TranslationMap translate 
)
inline
~UniformScaleTranslateMap ( )
overridedefault

Member Function Documentation

Mat3d applyIJC ( const Mat3d in) const
inlineoverridevirtualinherited

Return the Jacobian Curvature: zero for a linear map.

Implements MapBase.

Mat3d applyIJC ( const Mat3d in,
const Vec3d ,
const Vec3d  
) const
inlineoverridevirtualinherited

Implements MapBase.

Vec3d applyIJT ( const Vec3d in,
const Vec3d  
) const
inlineoverridevirtualinherited

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

Ignores second argument

Implements MapBase.

Vec3d applyIJT ( const Vec3d in) const
inlineoverridevirtualinherited

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

Implements MapBase.

Vec3d applyInverseJacobian ( const Vec3d in,
const Vec3d  
) const
inlineoverridevirtualinherited

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
inlineoverridevirtualinherited

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
inlineoverridevirtualinherited

Return the pre-image of under the map.

Implements MapBase.

Vec3d applyJacobian ( const Vec3d in,
const Vec3d  
) const
inlineoverridevirtualinherited

Return the Jacobian of the map applied to in.

Implements MapBase.

Vec3d applyJacobian ( const Vec3d in) const
inlineoverridevirtualinherited

Return the Jacobian of the map applied to in.

Implements MapBase.

Vec3d applyJT ( const Vec3d in,
const Vec3d  
) const
inlineoverridevirtualinherited

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
inlineoverridevirtualinherited

Return the Jacobian Transpose of the map applied to in.

Implements MapBase.

Vec3d applyMap ( const Vec3d in) const
inlineoverridevirtualinherited

Return the image of under the map.

Implements MapBase.

MapBase::Ptr copy ( ) const
inlineoverridevirtual

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

Reimplemented from ScaleTranslateMap.

static MapBase::Ptr create ( )
inlinestatic
double determinant ( const Vec3d ) const
inlineoverridevirtualinherited

Return the product of the scale values, ignores argument.

Implements MapBase.

double determinant ( ) const
inlineoverridevirtualinherited

Return the product of the scale values.

Implements MapBase.

AffineMap::Ptr getAffineMap ( ) const
inlineoverridevirtualinherited

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

Implements MapBase.

const Vec3d& getInvScale ( ) const
inlineinherited

Return 1/(scale)

const Vec3d& getInvScaleSqr ( ) const
inlineinherited

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

const Vec3d& getInvTwiceScale ( ) const
inlineinherited

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

const Vec3d& getScale ( ) const
inlineinherited

Returns the scale values.

const Vec3d& getTranslation ( ) const
inlineinherited

Returns the translation.

bool hasUniformScale ( ) const
inlineoverridevirtualinherited

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

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.

Reimplemented from ScaleTranslateMap.

bool isEqual ( const MapBase other) const
inlineoverridevirtual

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

Reimplemented from ScaleTranslateMap.

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

Return true (a ScaleTranslateMap 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 ScaleTranslateMap other) const
inlineinherited
bool operator!= ( const UniformScaleTranslateMap other) const
inline
bool operator== ( const ScaleTranslateMap other) const
inlineinherited
bool operator== ( const UniformScaleTranslateMap other) const
inline
MapBase::Ptr postRotate ( double  radians,
Axis  axis 
) const
inlineoverridevirtualinherited

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

Implements MapBase.

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

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

Implements MapBase.

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

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

Implements MapBase.

MapBase::Ptr 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 ScaleTranslateMap.

MapBase::Ptr preRotate ( double  radians,
Axis  axis 
) const
inlineoverridevirtualinherited

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

Implements MapBase.

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

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

Implements MapBase.

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

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

Implements MapBase.

MapBase::Ptr 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 ScaleTranslateMap.

void read ( std::istream &  is)
inlineoverridevirtualinherited

read serialization

Implements MapBase.

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

string serialization, useful for debuging

Implements MapBase.

Name type ( ) const
inlineoverridevirtual

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

Reimplemented from ScaleTranslateMap.

Vec3d voxelSize ( ) const
inlineoverridevirtualinherited

Return the absolute values of the scale values.

Implements MapBase.

Vec3d voxelSize ( const Vec3d ) const
inlineoverridevirtualinherited

Return the absolute values of the scale values, ignores argument.

Implements MapBase.

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

write serialization

Implements MapBase.


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