IPoint3FieldSampler Class Reference

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/IFieldHelper.h>

Public Member Functions
	IPoint3FieldSampler ()
virtual	~IPoint3FieldSampler ()=default
virtual bool	Sample (const Point3 &pos, Point3 &valueOut, float &strengthOut)
	Sample a point in the IFieldHelper's local space and obtain a Point3 value.

Constructor & Destructor Documentation

IPoint3FieldSampler()

IPoint3FieldSampler ( )

inline

{}

~IPoint3FieldSampler()

virtual ~IPoint3FieldSampler ( )

virtualdefault

Member Function Documentation

Sample()

virtual bool Sample ( const Point3 & pos, Point3 & valueOut, float & strengthOut )

inlinevirtual

Sample a point in the IFieldHelper's local space and obtain a Point3 value.

Samples a point in space. If the point is located within the field, the method returns 'true' and fills in the 'valueOut' with the value of the field at that location and 'strengthOut' with a strength value in the range [0,1]

Parameters

[in]	pos	: The position to be sampled, in the local space of the IFieldHelper
[out]	valueOut	The value of the point in space, if the point being sampled lies within the field bounds. Can be any value, determined by the field.
[out]	strengthOut	: The strength of the field at the given point in space, if the point being sampled lies within the field bounds. Range is [0,1]

Returns

'true' if the point being sampled lies within the field; otherwise 'false'

    {
        return false;
    }