Public Member Functions | Public Attributes

StdUVGen Class Reference

This reference page is linked to from the following overview topics: Texture Coordinates.


Search for all occurrences

Detailed Description

See also:
Class 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.
Method Groups:
See Method Groups for Class StdUVGen.

#include <stdmat.h>

Inheritance diagram for StdUVGen:
Inheritance graph
[legend]

List of all members.

Public Member Functions

BOOL  IsStdUVGen ()
virtual void  SetCoordMapping (int)=0
virtual void  SetUOffs (float f, TimeValue t)=0
virtual void  SetVOffs (float f, TimeValue t)=0
virtual void  SetUScl (float f, TimeValue t)=0
virtual void  SetVScl (float f, TimeValue t)=0
virtual void  SetAng (float f, TimeValue t)=0
virtual void  SetUAng (float f, TimeValue t)=0
virtual void  SetVAng (float f, TimeValue t)=0
virtual void  SetWAng (float f, TimeValue t)=0
virtual void  SetBlur (float f, TimeValue t)=0
virtual void  SetBlurOffs (float f, TimeValue t)=0
virtual void  SetNoiseAmt (float f, TimeValue t)=0
virtual void  SetNoiseSize (float f, TimeValue t)=0
virtual void  SetNoiseLev (int i, TimeValue t)=0
virtual void  SetNoisePhs (float f, TimeValue t)=0
virtual void  SetTextureTiling (int tiling)=0
virtual void  SetMapChannel (int i)=0
virtual void  SetFlag (ULONG f, ULONG val)=0
virtual void  SetHideMapBackFlag (BOOL b)=0
virtual int  GetCoordMapping (int)=0
virtual float  GetUOffs (TimeValue t)=0
virtual float  GetVOffs (TimeValue t)=0
virtual float  GetUScl (TimeValue t)=0
virtual float  GetVScl (TimeValue t)=0
virtual float  GetAng (TimeValue t)=0
virtual float  GetUAng (TimeValue t)=0
virtual float  GetVAng (TimeValue t)=0
virtual float  GetWAng (TimeValue t)=0
virtual float  GetBlur (TimeValue t)=0
virtual float  GetBlurOffs (TimeValue t)=0
virtual float  GetNoiseAmt (TimeValue t)=0
virtual float  GetNoiseSize (TimeValue t)=0
virtual int  GetNoiseLev (TimeValue t)=0
virtual float  GetNoisePhs (TimeValue t)=0
virtual int  GetTextureTiling ()=0
virtual int  GetMapChannel ()=0
virtual int  GetFlag (ULONG f)=0
virtual BOOL  GetHideMapBackFlag ()=0
virtual void  SetUseRealWorldScale (BOOL useRWS)=0
virtual BOOL  GetUseRealWorldScale ()=0

Public Attributes

void *  m_geoRefInfo

Member Function Documentation

BOOL IsStdUVGen ( ) [inline, virtual]
Remarks:
This method asks the question 'Is this class an instance of StdUVGen?'. The derived class StdUVGen implements this to return TRUE. Others use the default implementation to return FALSE.
Default Implementation:
{ return FALSE; }

Reimplemented from UVGen.

{ return TRUE; }  // method inherited from UVGen
virtual void SetCoordMapping ( int  ) [pure virtual]
Remarks:
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.
virtual void SetUOffs ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetVOffs ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetUScl ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetVScl ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetAng ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetUAng ( float  f,
TimeValue  t 
) [pure virtual]
Remarks:
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.
virtual void SetVAng ( float  f,
TimeValue  t 
) [pure virtual]
Remarks:
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.
virtual void SetWAng ( float  f,
TimeValue  t 
) [pure virtual]
Remarks:
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.
virtual void SetBlur ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetBlurOffs ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetNoiseAmt ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetNoiseSize ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetNoiseLev ( int  i,
TimeValue  t 
) [pure virtual]
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.
virtual void SetNoisePhs ( float  f,
TimeValue  t 
) [pure virtual]
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.
virtual void SetTextureTiling ( int  tiling ) [pure virtual]
Remarks:
Sets the texture tiling setting.
Parameters:
int tiling

See texture_symmetry_flags::html.

Implements UVGen.

virtual void SetMapChannel ( int  i ) [pure virtual]
Remarks:
Sets the mapping channel to the specified value.
Parameters:
int i

The channel to set.

Reimplemented from UVGen.

virtual void SetFlag ( ULONG  f,
ULONG  val 
) [pure virtual]
Remarks:
This method allows you to set the UVGen flags.
Parameters:
ULONG f

See texture_symmetry_flags::html.

ULONG val

The value to set.
virtual void SetHideMapBackFlag ( BOOL  b ) [pure virtual]
Remarks:
This method allows you to set the hide map back flag.
Parameters:
BOOL b

TRUE to set the flag; FALSE to disable.
virtual int GetCoordMapping ( int  ) [pure virtual]
Remarks:
Retrieves the coordinate mapping type.
Parameters:
int

This parameter is not used.
Returns:
One of the following values:

UVMAP_EXPLICIT

UVMAP_SPHERE_ENV

UVMAP_CYL_ENV

UVMAP_SHRINK_ENV

UVMAP_SCREEN_ENV
virtual float GetUOffs ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the U Offset setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetVOffs ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the V Offset setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetUScl ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the U Tiling setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetVScl ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the V Tiling setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetAng ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the angle setting in radians.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetUAng ( TimeValue  t ) [pure virtual]
Remarks:
Returns the U Angle setting (in radians) at the specified time.
Parameters:
TimeValue t

The time at which to return the angle.
virtual float GetVAng ( TimeValue  t ) [pure virtual]
Remarks:
Returns the V Angle setting (in radians) at the specified time.
Parameters:
TimeValue t

The time at which to return the angle.
virtual float GetWAng ( TimeValue  t ) [pure virtual]
Remarks:
Returns the W Angle setting (in radians) at the specified time.
Parameters:
TimeValue t

The time at which to return the angle.
virtual float GetBlur ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the blur setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetBlurOffs ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the blur offset setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetNoiseAmt ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the noise amount setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetNoiseSize ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the noise size setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual int GetNoiseLev ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the noise level setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual float GetNoisePhs ( TimeValue  t ) [pure virtual]
Remarks:
Retrieves the noise phase setting at the specified time.
Parameters:
TimeValue t

The time to retrieve the value.
virtual int GetTextureTiling ( ) [pure virtual]
Remarks:
Returns the texture tiling flags.
Returns:
See texture_symmetry_flags::html.

Implements UVGen.

virtual int GetMapChannel ( ) [pure virtual]
Remarks:
Returns the mapping channel.

Reimplemented from UVGen.

virtual int GetFlag ( ULONG  f ) [pure virtual]
Remarks:
This method returns the flag status of the UVGen.
Parameters:
ULONG f

See texture_symmetry_flags::html.
virtual BOOL GetHideMapBackFlag ( ) [pure virtual]
Remarks:
This method returns the state of the hide map back flag.
virtual void SetUseRealWorldScale ( BOOL  useRWS ) [pure virtual]
Remarks:
Sets whether to use real world mapping.

virtual BOOL GetUseRealWorldScale ( ) [pure virtual]
Remarks:
Queries whether real world mapping is used.

Member Data Documentation

void* m_geoRefInfo

StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen
StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen StdUVGen