Class StdUVGen

3DS Max Plug-In SDK

Class StdUVGen

See Also: Class UVGen.

class StdUVGen : public UVGen

Description:

This class provides access to the parameters of the 3ds max UVGen class. These are the settings in the 'Coordinates' and 'Noise' rollups such as UV offsets, angle, blur, noise level, etc. All methods of this class are implemented by the system.

Methods Groups:

The following hyperlinks take you to the beginning of groups of related method within the class.

Setting properties

Retrieving properties

Methods:

Setting properties

Prototype:

virtual void SetCoordMapping(int)=0;

Remarks:

This method is available in release 2.0 and later only.

Sets the mapping type to one of the specified values.

Parameters:

int

The mapping type. One of the following values:

UVMAP_EXPLICIT

Explicit Texture mapping.

UVMAP_SPHERE_ENV

Spherical Environment mapping.

UVMAP_CYL_ENV

Cylindrical Environment mapping.

UVMAP_SHRINK_ENV

Shrink Wrap Environment mapping.

UVMAP_SCREEN_ENV

Screen Environment mapping.

Prototype:

virtual void SetUOffs(float f, TimeValue t)=0;

Remarks:

Sets the U Offset setting to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetVOffs(float f, TimeValue t)=0;

Remarks:

Sets the V Offset setting to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetUScl(float f, TimeValue t)=0;

Remarks:

Sets the U tiling setting to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetVScl(float f, TimeValue t)=0;

Remarks:

Sets the V tiling setting to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetAng(float f, TimeValue t)=0;

Remarks:

Sets the angle setting to the specified value at the time passed.

Parameters:

float f

The value to set in radians.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetUAng(float f, TimeValue t)=0;

Remarks:

This method is available in release 3.0 and later only.

Sets the U Angle setting the specified value at the time passed.

Parameters:

float f

The angle to set in radians.

TimeValue t

The time at which to set the angle.

Prototype:

virtual void SetVAng(float f, TimeValue t)=0;

Remarks:

This method is available in release 3.0 and later only.

Sets the V Angle setting the specified value at the time passed.

Parameters:

float f

The angle to set in radians.

TimeValue t

The time at which to set the angle.

Prototype:

virtual void SetWAng(float f, TimeValue t)=0;

Remarks:

This method is available in release 3.0 and later only.

Sets the W Angle setting the specified value at the time passed.

Parameters:

float f

The angle to set in radians.

TimeValue t

The time at which to set the angle.

Prototype:

virtual void SetBlur(float f, TimeValue t)=0;

Remarks:

Sets the blur to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetBlurOffs(float f, TimeValue t)=0;

Remarks:

Sets the blur offset to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetNoiseAmt(float f, TimeValue t)=0;

Remarks:

Sets the noise amount to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetNoiseSize(float f, TimeValue t)=0;

Remarks:

Sets the noise size to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetNoiseLev(int i, TimeValue t)=0;

Remarks:

Sets the noise level to the specified value at the time passed.

Parameters:

int i

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetNoisePhs(float f, TimeValue t)=0;

Remarks:

Sets the noise phase to the specified value at the time passed.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetTextureTiling(int tiling)=0;

Remarks:

Sets the texture tiling setting.

Parameters:

int tiling

See List of Texture Symmetry Flags.

Prototype:

virtual void SetMapChannel(int i)=0;

Remarks:

This method is available in release 3.0 and later only.

Sets the mapping channel to the specified value.

Parameters:

int i

The channel to set.

Prototype:

virtual void SetFlag(ULONG f, ULONG val)=0;

Remarks:

This method is available in release 4.0 and later only.

This method allows you to set the UVGen flags.

Parameters:

ULONG f

See List of Texture Symmetry Flags.

ULONG val

The value to set.

Prototype:

virtual void SetHideMapBackFlag(BOOL b)=0;

Remarks:

This method is available in release 4.0 and later only.

This method allows you to set the hide map back flag.

Parameters:

BOOL b

TRUE to set the flag; FALSE to disable.

Retrieving properties

Prototype:

virtual int GetCoordMapping(int)=0;

Remarks:

Retrieves the coordinate mapping type.

Parameters:

int

This parameter is not used.

Return Value:

One of the following values:

UVMAP_EXPLICIT

UVMAP_SPHERE_ENV

UVMAP_CYL_ENV

UVMAP_SHRINK_ENV

UVMAP_SCREEN_ENV

Prototype:

virtual float GetUOffs(TimeValue t)=0;

Remarks:

Retrieves the U Offset setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetVOffs(TimeValue t)=0;

Remarks:

Retrieves the V Offset setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetUScl(TimeValue t)=0;

Remarks:

Retrieves the U Tiling setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetVScl(TimeValue t)=0;

Remarks:

Retrieves the V Tiling setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetAng(TimeValue t)=0;

Remarks:

Retrieves the angle setting in radians.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetUAng(TimeValue t)=0;

Remarks:

This method is available in release 3.0 and later only.

Returns the U Angle setting (in radians) at the specified time.

Parameters:

TimeValue t

The time at which to return the angle.

Prototype:

virtual float GetVAng(TimeValue t)=0;

Remarks:

This method is available in release 3.0 and later only.

Returns the V Angle setting (in radians) at the specified time.

Parameters:

TimeValue t

The time at which to return the angle.

Prototype:

virtual float GetWAng(TimeValue t)=0;

Remarks:

This method is available in release 3.0 and later only.

Returns the W Angle setting (in radians) at the specified time.

Parameters:

TimeValue t

The time at which to return the angle.

Prototype:

virtual float GetBlur(TimeValue t)=0;

Remarks:

Retrieves the blur setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetBlurOffs(TimeValue t)=0;

Remarks:

Retrieves the blur offset setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetNoiseAmt(TimeValue t)=0;

Remarks:

Retrieves the noise amount setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetNoiseSize(TimeValue t)=0;

Remarks:

Retrieves the noise size setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual int GetNoiseLev(TimeValue t)=0;

Remarks:

Retrieves the noise level setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual float GetNoisePhs(TimeValue t)=0;

Remarks:

Retrieves the noise phase setting at the specified time.

Parameters:

TimeValue t

The time to retrieve the value.

Prototype:

virtual int GetTextureTiling()=0;

Remarks:

Returns the texture tiling flags.

Return Value:

See List of Texture Symmetry Flags.

Prototype:

virtual int GetMapChannel()=0;

Remarks:

This method is available in release 3.0 and later only.

Returns the mapping channel.

Prototype:

virtual int GetFlag(ULONG f)=0;

Remarks:

This method is available in release 4.0 and later only.

This method returns the flag status of the UVGen.

Parameters:

ULONG f

See List of Texture Symmetry Flags.

Prototype:

virtual BOOL GetHideMapBackFlag()=0;

Remarks:

This method is available in release 4.0 and later only.

This method returns the state of the hide map back flag.