IShapeRectRenderParams Class Reference

Search for all occurrences

---

Detailed Description

Rectangular Shape Render Parameters API This interface gives access to the new Renderable SPline parameters for Rectangular Shapes The IShapeRectRenderParams interface can be retrieved like this: IShapeRectRenderParams* rparams = (IShapeRectRenderParams*)obj->GetProperty(SHAPE_RECT_RENDERPARAMS_PROPID); Note that this interface contains VPT and non VPT parameters.

The non VPT parameters are used for the renderer and the viewport in case GetViewportOrRenderer() returns true, or if GetViewportOrRenderer() returns false and GetUseViewPort() returns false. Otherwise the non vpt settings only control the mesh for the renderer, not the viewport.

#include <object.h>

Inheritance diagram for IShapeRectRenderParams:

List of all members.

Public Member Functions
	IShapeRectRenderParams (ShapeObject *so)
	Constructor.
CoreExport BOOL	GetRectangular (TimeValue t) const
	Gets the Rectangular setting of the shape.
CoreExport void	SetRectangular (TimeValue t, BOOL rectangular)
	Sets the Rectangular setting of the shape.
CoreExport float	GetWidth (TimeValue t) const
	Gets the Width of the rectangular section of the shape.
CoreExport void	SetWidth (TimeValue t, float width)
	Sets the Width of the rectangular section of the shape.
CoreExport float	GetLength (TimeValue t) const
	Gets the Length of the rectangular section of the shape.
CoreExport void	SetLength (TimeValue t, float length)
	Sets the Length of the rectangular section of the shape.
CoreExport float	GetAngle2 (TimeValue t) const
	Gets the Angle of the rectangular section of the shape.
CoreExport void	SetAngle2 (TimeValue t, float angle)
	Sets the Angle of the rectangular section of the shape.
CoreExport BOOL	GetAspectLock (TimeValue t) const
	Gets the AspectLock parameter of the rectangular section of the shape.
CoreExport void	SetAspectLock (TimeValue t, BOOL aspectLock)
	Sets the AspectLock parameter of the rectangular section of the shape.
CoreExport BOOL	GetVPTRectangular (TimeValue t) const
	Gets the Rectangular setting of the shape for the viewport.
CoreExport void	SetVPTRectangular (TimeValue t, BOOL rectangular)
	Sets the Rectangular parameter of the rectangular section of the shape for the viewport.
CoreExport float	GetVPTWidth (TimeValue t) const
	Gets the Width of the rectangular section of the shape for the viewport.
CoreExport void	SetVPTWidth (TimeValue t, float width)
	Sets the Width of the rectangular section of the shape for the viewport.
CoreExport float	GetVPTLength (TimeValue t) const
	Gets the Length of the rectangular section of the shape for the viewport.
CoreExport void	SetVPTLength (TimeValue t, float length)
	Sets the Length of the rectangular section of the shape for the viewport.
CoreExport float	GetVPTAngle2 (TimeValue t) const
	Gets the Angle of the rectangular section of the shape for the viewport.
CoreExport void	SetVPTAngle2 (TimeValue t, float angle)
	Sets the Angle of the rectangular section of the shape for the viewport.
CoreExport BOOL	GetVPTAspectLock (TimeValue t) const
	Gets the AspectLock parameter of the rectangular section of the shape for the viewport.
CoreExport void	SetVPTAspectLock (TimeValue t, BOOL aspectLock)
	Sets the AspectLock parameter of the rectangular section of the shape for the viewport.
CoreExport BOOL	GetAutosmooth (TimeValue t) const
	Gets the AutoSmooth parameter of the shape.
CoreExport void	SetAutosmooth (TimeValue t, BOOL autosmooth)
	Sets the AutoSmooth parameter of the shape for the viewport.
CoreExport float	GetAutosmoothThreshold (TimeValue t) const
	Gets the AutoSmooth Threshold of the shape.
CoreExport void	SetAutosmoothThreshold (TimeValue t, float threshold)
	Sets the AutoSmooth Threshold of the shape.
DWORD	ID ()
	ID of this AnimProperty.
Protected Attributes
ShapeObject *	mShape

---

Constructor & Destructor Documentation

IShapeRectRenderParams

(

ShapeObject *

so

)

[inline]

Constructor.

Parameters:

so	- ShapeObject that publishes this interface

                                            : mShape(so)
    {
    }

---

Member Function Documentation

CoreExport BOOL GetRectangular

(

TimeValue

t

)

const

Search for all occurrences

Gets the Rectangular setting of the shape.

Parameters:

t	- Time to get the value for

Returns:

Rectangular setting of the shape

CoreExport void SetRectangular	(	TimeValue	t,
		BOOL	rectangular
	)

Search for all occurrences

Sets the Rectangular setting of the shape.

Parameters:

t	- Time to set the value for
rectangular	- if true, shape is rectangular, if false radial

CoreExport float GetWidth

(

TimeValue

t

)

const

Search for all occurrences

Gets the Width of the rectangular section of the shape.

Parameters:

t	- Time to get the value for

Returns:

Width of the rectangular section of the shape

CoreExport void SetWidth	(	TimeValue	t,
		float	width
	)

Search for all occurrences

Sets the Width of the rectangular section of the shape.

Parameters:

t	- Time to set the value for
width	- Width Value (must be positive)

CoreExport float GetLength

(

TimeValue

t

)

const

Search for all occurrences

Gets the Length of the rectangular section of the shape.

Parameters:

t	- Time to get the value for

Returns:

Length of the rectangular section of the shape

CoreExport void SetLength	(	TimeValue	t,
		float	length
	)

Search for all occurrences

Sets the Length of the rectangular section of the shape.

Parameters:

t	- Time to set the value for
length	- Length Value (must be positive)

CoreExport float GetAngle2

(

TimeValue

t

)

const

Search for all occurrences

Gets the Angle of the rectangular section of the shape.

Parameters:

t	- Time to get the value for

Returns:

Angle of the rectangular section of the shape

CoreExport void SetAngle2	(	TimeValue	t,
		float	angle
	)

Search for all occurrences

Sets the Angle of the rectangular section of the shape.

Parameters:

t	- Time to set the value for
angle	- Angle Value for rectangular shape

CoreExport BOOL GetAspectLock

(

TimeValue

t

)

const

Search for all occurrences

Gets the AspectLock parameter of the rectangular section of the shape.

Parameters:

t	- Time to get the value for

Returns:

AspectLock parameter of the rectangular section of the shape

CoreExport void SetAspectLock	(	TimeValue	t,
		BOOL	aspectLock
	)

Search for all occurrences

Sets the AspectLock parameter of the rectangular section of the shape.

Parameters:

t	- Time to set the value for
aspectLock	- TRUE if aspect is locked, FALSE otherwise

CoreExport BOOL GetVPTRectangular

(

TimeValue

t

)

const

Search for all occurrences

Gets the Rectangular setting of the shape for the viewport.

Parameters:

t	- Time to get the value for

Returns:

Rectangular setting of the shape for the viewport

CoreExport void SetVPTRectangular	(	TimeValue	t,
		BOOL	rectangular
	)

Search for all occurrences

Sets the Rectangular parameter of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to set the value for
rectangular	- if true, shape is rectangular, if false radial

CoreExport float GetVPTWidth

(

TimeValue

t

)

const

Search for all occurrences

Gets the Width of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to get the value for

Returns:

Width of the rectangular section of the shape for the viewport

CoreExport void SetVPTWidth	(	TimeValue	t,
		float	width
	)

Search for all occurrences

Sets the Width of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to set the value for
width	- Width Value (must be positive)

CoreExport float GetVPTLength

(

TimeValue

t

)

const

Search for all occurrences

Gets the Length of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to get the value for

Returns:

Length of the rectangular section of the shape for the viewport

CoreExport void SetVPTLength	(	TimeValue	t,
		float	length
	)

Search for all occurrences

Sets the Length of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to set the value for
length	- Length Value (must be positive)

CoreExport float GetVPTAngle2

(

TimeValue

t

)

const

Search for all occurrences

Gets the Angle of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to get the value for

Returns:

Angle of the rectangular section of the shape for the viewport

CoreExport void SetVPTAngle2	(	TimeValue	t,
		float	angle
	)

Search for all occurrences

Sets the Angle of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to set the value for
angle	- Angle Value for rectangular shape

CoreExport BOOL GetVPTAspectLock

(

TimeValue

t

)

const

Search for all occurrences

Gets the AspectLock parameter of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to get the value for

Returns:

AspectLock parameter of the rectangular section of the shape for the viewport

CoreExport void SetVPTAspectLock	(	TimeValue	t,
		BOOL	aspectLock
	)

Search for all occurrences

Sets the AspectLock parameter of the rectangular section of the shape for the viewport.

Parameters:

t	- Time to set the value for
aspectLock	- TRUE if aspect is locked, FALSE otherwise

CoreExport BOOL GetAutosmooth

(

TimeValue

t

)

const

Search for all occurrences

Gets the AutoSmooth parameter of the shape.

Parameters:

t	- Time to get the value for

Returns:

AutoSmooth parameter of the shape

CoreExport void SetAutosmooth	(	TimeValue	t,
		BOOL	autosmooth
	)

Search for all occurrences

Sets the AutoSmooth parameter of the shape for the viewport.

Parameters:

t	- Time to set the value for
autosmooth	- TRUE if resulting mesh should be autosmoothed, FALSE otherwise

CoreExport float GetAutosmoothThreshold

(

TimeValue

t

)

const

Search for all occurrences

Gets the AutoSmooth Threshold of the shape.

Parameters:

t	- Time to get the value for

Returns:

AutoSmooth Threshold of the shape

CoreExport void SetAutosmoothThreshold	(	TimeValue	t,
		float	threshold
	)

Search for all occurrences

Sets the AutoSmooth Threshold of the shape.

Parameters:

t	- Time to set the value for
threshold	- threashold angle in radians

DWORD ID

(

)

[inline, virtual]

Search for all occurrences

ID of this AnimProperty.

Returns:

ID of this AnimProperty

Implements AnimProperty.

{ return SHAPE_RECT_RENDERPARAMS_PROPID;}

---

Member Data Documentation

ShapeObject* mShape [protected]

Search for all occurrences