Class StdXYZGen

3DS Max Plug-In SDK

Class StdXYZGen

See Also: Class XYZGen.

class StdXYZGen: public XYZGen

Description:

This class is available in release 2.0 and later only.

This class provides access to the parameters of the 3ds max XYZGen class. The XYZGen class puts up the 3D 'Coordinates' rollup.

Methods:

Prototype:

BOOL IsStdXYZGen();

Remarks:

This is an implementation of a method of XYZGen. This returns TRUE to indicate this is a StdXYZGen instance.

Prototype:

virtual void SetCoordSystem(int s)=0;

Remarks:

Sets the coordinate system used.

Parameters:

int s

The coordinate system to set. One of the following values:

XYZ_COORDS - Object XYZ

UVW_COORDS - Explicit Map Channel

UVW2_COORDS - Vertex Color Channel

XYZ_WORLD_COORDS - World XYZ. This option is available in release 3.0 and later only.

Prototype:

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

Remarks:

Sets the Blur setting to the specified value at the specified time.

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 setting to the specified value at the specified time.

Parameters:

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetOffs(int axis, float f, TimeValue t)=0;

Remarks:

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

Parameters:

int axis

The axis to set. 0 for X, 1 for Y, 2 for Z.

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

virtual void SetScl(int axis, float f, TimeValue t)=0;

Remarks:

Sets the specified Tiling (Scale) setting to the specified value at the specified time.

Parameters:

int axis

The axis to set. 0 for X, 1 for Y, 2 for Z.

float f

The value to set.

TimeValue t

The time at which to set the value.

Prototype:

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

Remarks:

Sets the specified Angle setting to the specified value at the specified time.

Parameters:

int axis

The axis to set. 0 for X, 1 for Y, 2 for Z.

float f

The value to set.

TimeValue t

The time at which to set the value.

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 mapping channel to set.

Prototype:

virtual int GetCoordSystem()=0;

Remarks:

Returns the coordinate system in use. One of the following values:

XYZ_COORDS - Object XYZ

UVW_COORDS - Explicit Map Channel

UVW2_COORDS - Vertex Color Channel

XYZ_WORLD_COORDS - World XYZ. This option is available in release 3.0 and later only.

Prototype:

virtual float GetBlur(TimeValue t)=0;

Remarks:

Returns the Blur setting at the specified time.

Parameters:

TimeValue t

The time at which to retrieve the value.

Prototype:

virtual float GetBlurOffs(TimeValue t)=0;

Remarks:

Returns the Blur Offset setting at the specified time.

Parameters:

TimeValue t

The time at which to retrieve the value.

Prototype:

virtual float GetScl(int axis, TimeValue t)=0;

Remarks:

Returns the Tiling (Scale) setting for the specified axis at the specified time.

Parameters:

int axis

The axis to set. 0 for X, 1 for Y, 2 for Z.

TimeValue t

The time at which to retrieve the value.

Prototype:

virtual float GetAng(int axis, TimeValue t)=0;

Remarks:

Returns the Angle setting for the specified axis at the specified time.

Parameters:

int axis

The axis to set. 0 for X, 1 for Y, 2 for Z.

TimeValue t

The time at which to retrieve the value.

Prototype:

virtual int GetMapChannel()=0;

Remarks:

This method is available in release 3.0 and later only.

Returns the mapping channel.