ISurfPosition Class Reference
 
 
 
ISurfPosition Class Reference

This reference page is linked to from the following overview topics: Controller API Elements.


#include <istdplug.h>

Inheritance diagram for ISurfPosition:
Control ReferenceTarget ReferenceMaker Animatable InterfaceServer Noncopyable MaxHeapOperators MaxHeapOperators

Class Description

See also:
Class Control, Class INode.

Description:
This class provides access to the surface position controller's parameters.

The following values may be used to access the surface controller's references.

SURFCONT_U_REF

SURFCONT_V_REF

SURFCONT_SURFOBJ_REF

All methods of this class are implemented by the system.

Public Member Functions

virtual void  SetSurface (INode *node)=0
virtual int  GetAlign ()=0
virtual void  SetAlign (int a)=0
virtual BOOL  GetFlip ()=0
virtual void  SetFlip (BOOL f)=0

Member Function Documentation

virtual void SetSurface ( INode node ) [pure virtual]
Remarks:
Sets the node that this controller uses as the surface object.
Parameters:
INode *node

Points to the node to set.
virtual int GetAlign ( ) [pure virtual]
Remarks:
Returns the alignment setting.
Returns:
One of the following values:

0: No Alignment.

1: Align to U.

2: Align to V.
virtual void SetAlign ( int  a ) [pure virtual]
Remarks:
Sets the alignment setting.
Parameters:
int a

One of the following values:

0: No Alignment.

1: Align to U.

2: Align to V.
virtual BOOL GetFlip ( ) [pure virtual]
Remarks:
Returns the flip setting. TRUE if on; FALSE if off.
virtual void SetFlip ( BOOL  f ) [pure virtual]
Remarks:
Sets the flip setting.
Parameters:
BOOL f

TRUE for on; FALSE for off.