StdXYZGen Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class 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.

#include <stdmat.h>

Inheritance diagram for StdXYZGen:

List of all members.

Public Member Functions
BOOL	IsStdXYZGen ()
virtual void	SetCoordSystem (int s)=0
virtual void	SetBlur (float f, TimeValue t)=0
virtual void	SetBlurOffs (float f, TimeValue t)=0
virtual void	SetOffs (int axis, float f, TimeValue t)=0
virtual void	SetScl (int axis, float f, TimeValue t)=0
virtual void	SetAng (int axis, float f, TimeValue t)=0
virtual int	GetCoordSystem ()=0
virtual float	GetBlur (TimeValue t)=0
virtual float	GetBlurOffs (TimeValue t)=0
virtual float	GetOffs (int axis, TimeValue t)=0
virtual float	GetScl (int axis, TimeValue t)=0
virtual float	GetAng (int axis, TimeValue t)=0
virtual void	SetMapChannel (int i)=0
virtual int	GetMapChannel ()=0

---

Member Function Documentation

BOOL IsStdXYZGen

(

)

[inline, virtual]

Search for all occurrences

Remarks:

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

Reimplemented from XYZGen.

{ return TRUE; }

virtual void SetCoordSystem

(

int

s

)

[pure virtual]

Search for all occurrences

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.

virtual void SetBlur	(	float	f,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual void SetBlurOffs	(	float	f,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual void SetOffs	(	int	axis,
		float	f,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual void SetScl	(	int	axis,
		float	f,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual void SetAng	(	int	axis,
		float	f,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual int GetCoordSystem

(

)

[pure virtual]

Search for all occurrences

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.

virtual float GetBlur

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the Blur setting at the specified time.

Parameters:

TimeValue t

The time at which to retrieve the value.

virtual float GetBlurOffs

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the Blur Offset setting at the specified time.

Parameters:

TimeValue t

The time at which to retrieve the value.

virtual float GetOffs	(	int	axis,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

virtual float GetScl	(	int	axis,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual float GetAng	(	int	axis,
		TimeValue	t
	)		[pure virtual]

Search for all occurrences

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.

virtual void SetMapChannel

(

int

i

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the mapping channel to the specified value.

Parameters:

int i

The mapping channel to set.

virtual int GetMapChannel

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the mapping channel.