RenderManAPI  24.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RixTransform Class Referenceabstract

RixTransform provides transformation routines that operate over named coordinate systems in the renderer. More...

#include <RixInterfaces.h>

Inherits RixInterface.

Public Types

enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual int TransformPoints (RtUString const fromspace, RtUString const tospace, int n, RtPoint3 p[], float time)=0
 Transform an array of points 'p' of size 'n' from 'fromspace' to 'tospace' at a given 'time'. More...
 
virtual void TransformPoints (RtMatrix4x4 const &m, int n, RtPoint3 p[])=0
 Transform an array of points 'p' of size 'n' via matrix 'm'. More...
 
virtual int TransformMatrix (RtUString const fromspace, RtUString const tospace, float time, RtMatrix4x4 &m)=0
 Take 'fromspace' and 'tospace' and 'time' and return matrix 'm' representing that transformation. More...
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixTransform ()
 constructor for internal use only More...
 

Protected Attributes

int m_version
 Version number of this interface. More...
 

Detailed Description

RixTransform provides transformation routines that operate over named coordinate systems in the renderer.

Member Enumeration Documentation

◆ Type

enum RixInterface::Type
inherited
Enumerator
k_Float 
k_Integer 
k_StringV 
k_Color 
k_Normal 
k_Vector 
k_Point 
k_HPoint 
k_MPoint 
k_Matrix 

Constructor & Destructor Documentation

◆ RixTransform()

RixTransform::RixTransform ( )
inlineprotected

constructor for internal use only

Member Function Documentation

◆ GetVersion()

virtual int RixInterface::GetVersion ( ) const
inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

◆ TransformMatrix()

virtual int RixTransform::TransformMatrix ( RtUString const  fromspace,
RtUString const  tospace,
float  time,
RtMatrix4x4 &  m 
)
pure virtual

Take 'fromspace' and 'tospace' and 'time' and return matrix 'm' representing that transformation.

0 is returned on success and non-zero if the transform could not be made.

◆ TransformPoints() [1/2]

virtual int RixTransform::TransformPoints ( RtUString const  fromspace,
RtUString const  tospace,
int  n,
RtPoint3  p[],
float  time 
)
pure virtual

Transform an array of points 'p' of size 'n' from 'fromspace' to 'tospace' at a given 'time'.

0 is returned on success and non-zero if the transform could not be made.

◆ TransformPoints() [2/2]

virtual void RixTransform::TransformPoints ( RtMatrix4x4 const &  m,
int  n,
RtPoint3  p[] 
)
pure virtual

Transform an array of points 'p' of size 'n' via matrix 'm'.

Member Data Documentation

◆ m_version

int RixInterface::m_version
protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().

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