RenderManAPI  24.0
Public Member Functions | List of all members
ImplicitVertexValue Class Referenceabstract

#include <ImplicitField.h>

Public Member Functions

 ImplicitVertexValue ()
 
virtual ~ImplicitVertexValue ()
 
virtual void GetVertexValue (float *result, const RtPoint p)=0
 Stores in result the value of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at point p in object space at shutter open. More...
 
virtual void GetVertexValueFiltered (float *result, const RtPoint p, const RtPoint dPdu, const RtPoint dPdv, const RtPoint dPdw)
 Stores in result the filtered value of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated over the region delineated by point p, dPdu, dPdv, and dPdw in object space at shutter open. More...
 
virtual void GetVertexValueMultiple (int neval, float *result, int resultstride, const RtPoint *p)
 Stores in result the values of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval points p in object space at shutter open. More...
 
virtual void GetVertexValueMultipleFiltered (int neval, float *result, int resultstride, const RtPoint *p, const RtPoint *dPdu, const RtPoint *dPdv, const RtPoint *dPdw)
 Stores in result the filtered values of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval regions delineated by points p, dPdu, dPdv, and dPdw in object space at shutter open. More...
 
virtual void GetVertexValueMultipleTemporal (int neval, float *result, int resultstride, const RtPoint *p, const float *time)
 Stores in result the time-dependent values of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval points p in object space at the specified time. More...
 
virtual void GetVertexValueMultipleTemporalFiltered (int neval, float *result, int resultstride, const RtPoint *p, const RtPoint *dPdu, const RtPoint *dPdv, const RtPoint *dPdw, const float *time)
 Stores in result the time-dependent value of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval regions delineated by points p, dPdu, dPdv, and dPdw in object space at the specified time. More...
 
virtual size_t MemoryUsage ()
 Returns the memory consumption of the vertex value. More...
 

Constructor & Destructor Documentation

◆ ImplicitVertexValue()

ImplicitVertexValue::ImplicitVertexValue ( )
inline

◆ ~ImplicitVertexValue()

virtual ImplicitVertexValue::~ImplicitVertexValue ( )
inlinevirtual

Member Function Documentation

◆ GetVertexValue()

virtual void ImplicitVertexValue::GetVertexValue ( float *  result,
const RtPoint  p 
)
pure virtual

Stores in result the value of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at point p in object space at shutter open.

When this function is called, the result parameter already has a legal value computed (generally the value bound in RIB to the geometry).

Referenced by GetVertexValueFiltered(), and GetVertexValueMultiple().

◆ GetVertexValueFiltered()

virtual void ImplicitVertexValue::GetVertexValueFiltered ( float *  result,
const RtPoint  p,
const RtPoint  dPdu,
const RtPoint  dPdv,
const RtPoint  dPdw 
)
inlinevirtual

Stores in result the filtered value of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated over the region delineated by point p, dPdu, dPdv, and dPdw in object space at shutter open.

When this function is called, the result parameter already has a legal value computed (generally the value bound in RIB to the geometry).

References GetVertexValue(), and PIXAR_ARGUSED.

Referenced by GetVertexValueMultipleFiltered().

◆ GetVertexValueMultiple()

virtual void ImplicitVertexValue::GetVertexValueMultiple ( int  neval,
float *  result,
int  resultstride,
const RtPoint *  p 
)
inlinevirtual

Stores in result the values of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval points p in object space at shutter open.

When this function is called, the result parameter already has a legal value computed (generally the value bound in RIB to the geometry). The DSO must skip by resultstride when storing the results between each evaluation.

References GetVertexValue().

Referenced by GetVertexValueMultipleTemporal().

◆ GetVertexValueMultipleFiltered()

virtual void ImplicitVertexValue::GetVertexValueMultipleFiltered ( int  neval,
float *  result,
int  resultstride,
const RtPoint *  p,
const RtPoint *  dPdu,
const RtPoint *  dPdv,
const RtPoint *  dPdw 
)
inlinevirtual

Stores in result the filtered values of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval regions delineated by points p, dPdu, dPdv, and dPdw in object space at shutter open.

When this function is called, the result parameter already has a legal value computed (generally the value bound in RIB to the geometry). The DSO must skip by resultstride when storing the results between each evaluation.

References GetVertexValueFiltered().

Referenced by GetVertexValueMultipleTemporalFiltered().

◆ GetVertexValueMultipleTemporal()

virtual void ImplicitVertexValue::GetVertexValueMultipleTemporal ( int  neval,
float *  result,
int  resultstride,
const RtPoint *  p,
const float *  time 
)
inlinevirtual

Stores in result the time-dependent values of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval points p in object space at the specified time.

When this function is called, the result parameter already has a legal value computed (generally the value bound in RIB to the geometry). The DSO must skip by resultstride when storing the results between each evaluation.

References GetVertexValueMultiple(), and PIXAR_ARGUSED.

◆ GetVertexValueMultipleTemporalFiltered()

virtual void ImplicitVertexValue::GetVertexValueMultipleTemporalFiltered ( int  neval,
float *  result,
int  resultstride,
const RtPoint *  p,
const RtPoint *  dPdu,
const RtPoint *  dPdv,
const RtPoint *  dPdw,
const float *  time 
)
inlinevirtual

Stores in result the time-dependent value of the named vertex variable associated with the call to CreateVertexValue that created this ImplicitVertexValue, evaluated at neval regions delineated by points p, dPdu, dPdv, and dPdw in object space at the specified time.

When this function is called, the result parameter already has a legal value computed (generally the value bound in RIB to the geometry). The DSO must skip by resultstride when storing the results between each evaluation.

References GetVertexValueMultipleFiltered(), and PIXAR_ARGUSED.

◆ MemoryUsage()

virtual size_t ImplicitVertexValue::MemoryUsage ( )
inlinevirtual

Returns the memory consumption of the vertex value.

The renderer may call this at multiple times during the course of the render to gauge the memory usage characteristics of the plugin.

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