Medial Code Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | Related Symbols
Eigen::UniformScaling< _Scalar > Class Template Reference

\geometry_module More...

#include <Scaling.h>

Public Types

typedef _Scalar Scalar
 the scalar type of the coefficients
 

Public Member Functions

 UniformScaling ()
 Default constructor without initialization.
 
 UniformScaling (const Scalar &s)
 Constructs and initialize a uniform scaling transformation.
 
const Scalarfactor () const
 
Scalarfactor ()
 
UniformScaling operator* (const UniformScaling &other) const
 Concatenates two uniform scaling.
 
template<int Dim>
Transform< Scalar, Dim, Affineoperator* (const Translation< Scalar, Dim > &t) const
 Concatenates a uniform scaling and a translation.
 
template<int Dim, int Mode, int Options>
internal::uniformscaling_times_affine_returntype< Scalar, Dim, Mode >::type operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
 Concatenates a uniform scaling and an affine transformation.
 
template<typename Derived >
Eigen::internal::plain_matrix_type< Derived >::type operator* (const MatrixBase< Derived > &other) const
 Concatenates a uniform scaling and a linear transformation matrix.
 
template<typename Derived , int Dim>
Matrix< Scalar, Dim, Dim > operator* (const RotationBase< Derived, Dim > &r) const
 
UniformScaling inverse () const
 
template<typename NewScalarType >
UniformScaling< NewScalarType > cast () const
 
template<typename OtherScalarType >
 UniformScaling (const UniformScaling< OtherScalarType > &other)
 Copy constructor with scalar type conversion.
 
bool isApprox (const UniformScaling &other, const typename NumTraits< Scalar >::Real &prec=NumTraits< Scalar >::dummy_precision()) const
 

Protected Attributes

Scalar m_factor
 

Related Symbols

(Note that these are not member symbols.)

template<typename Derived , typename Scalar >
 operator* (const MatrixBase< Derived > &matrix, const UniformScaling< Scalar > &s)
 Concatenates a linear transformation matrix and a uniform scaling.
 

Detailed Description

template<typename _Scalar>
class Eigen::UniformScaling< _Scalar >

\geometry_module

Represents a generic uniform scaling transformation

Template Parameters
_Scalarthe scalar type, i.e., the type of the coefficients.

This class represent a uniform scaling transformation. It is the return type of Scaling(Scalar), and most of the time this is the only way it is used. In particular, this class is not aimed to be used to store a scaling transformation, but rather to make easier the constructions and updates of Transform objects.

To represent an axis aligned scaling, use the DiagonalMatrix class.

See also
Scaling(), class DiagonalMatrix, MatrixBase::asDiagonal(), class Translation, class Transform

Member Function Documentation

◆ cast()

template<typename _Scalar >
template<typename NewScalarType >
UniformScaling< NewScalarType > Eigen::UniformScaling< _Scalar >::cast ( ) const
inline
Returns
*this with scalar type casted to NewScalarType

Note that if NewScalarType is equal to the current scalar type of *this then this function smartly returns a const reference to *this.

◆ inverse()

template<typename _Scalar >
UniformScaling Eigen::UniformScaling< _Scalar >::inverse ( ) const
inline
Returns
the inverse scaling

◆ isApprox()

template<typename _Scalar >
bool Eigen::UniformScaling< _Scalar >::isApprox ( const UniformScaling< _Scalar > &  other,
const typename NumTraits< Scalar >::Real &  prec = NumTraits<Scalar>::dummy_precision() 
) const
inline
Returns
true if *this is approximately equal to other, within the precision determined by prec.
See also
MatrixBase::isApprox()

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