This reference page is linked to from the following overview topics: Object Plug-ins, Plug-in Base Classes.
Detailed Description
This is a base class used to create construction grid objects.
It implements a few of the methods of Animatable and Object and provides a few for working with construction grids.
- See also:
- Class HelperObject, Class INode, Class Object, Class ViewExp, Class Matrix3
#include <object.h>
Public Member Functions |
|
| ConstObject () | |
| int | IsConstObject () |
| Implemented by the System. |
|
| virtual void | GetConstructionTM (TimeValue t, INode *inode, ViewExp *vpt, Matrix3 &tm)=0 |
| This method returns the construction grid
transformation matrix. |
|
| virtual void | SetConstructionPlane (int which, int notify=TRUE)=0 |
| virtual int | GetConstructionPlane (void)=0 |
| virtual Point3 | GetSnaps (TimeValue t)=0 |
| This method is specific to construction
grids. |
|
| virtual void | SetSnaps (TimeValue t, Point3 p)=0 |
| virtual BOOL | NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm) |
| Objects that don't support the
IntersectRay() method (such as helper objects) can implement
this method to provide a default vector for use with the normal
align command in 3ds Max. |
|
| bool | IsTransient () const |
| void | SetTransient (bool state=true) |
| bool | IsTemporary () const |
| void | SetTemporary (bool state=true) |
| virtual void | SetExtents (TimeValue t, Point3 halfbox)=0 |
| virtual Point3 | GetExtents (TimeValue t)=0 |
Constructor & Destructor Documentation
| ConstObject | ( | ) | [inline] |
{ m_transient = m_temporary = false; }
Member Function Documentation
| int IsConstObject | ( | ) | [inline, virtual] |
Implemented by the System.
Returns 1 to indicate this object is a construction grid object.
Reimplemented from Object.
{ return 1; }
| virtual void GetConstructionTM | ( | TimeValue | t, |
| INode * | inode, | ||
| ViewExp * | vpt, | ||
| Matrix3 & | tm | ||
| ) | [pure virtual] |
This method returns the construction grid transformation matrix.
This is the world space orientation and position of the construction plane.
- Parameters:
-
t The time to retrieve the matrix. inode The node in the scene corresponding to the construction grid object. vpt The viewport the TM is being returned for. Certain construction grid objects might have a different plane for different viewports. tm The transform matrix for this view is returned here.
| virtual void SetConstructionPlane | ( | int | which, |
| int | notify =
TRUE |
||
| ) | [pure virtual] |
| virtual int GetConstructionPlane | ( | void | ) | [pure virtual] |
| virtual Point3 GetSnaps | ( | TimeValue | t | ) | [pure virtual] |
This method is specific to construction grids.
The system calls this method to retrieve the snap dimension of the grid. In the 3ds Max user interface for the construction grid helper object there is a spinner for 'Spacing'. This is the spacing for the grid. When GetSnaps() is called the Point3 returned will have this value in all three axes. This value is used, for example, when you create a box or other primitive and are setting the height dimension.
- Parameters:
-
t The time to retrieve the snap values.
| virtual void SetSnaps | ( | TimeValue | t, |
| Point3 | p | ||
| ) | [pure virtual] |
Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max.
- Parameters:
-
t The time to compute the normal align vector. pt The point of intersection. norm The normal at the point of intersection.
- Returns:
- TRUE if this method is implemented to return the normal align vector; otherwise FALSE.
Reimplemented from HelperObject.
| bool IsTransient | ( | ) | const [inline] |
{return m_transient;}
| void SetTransient | ( | bool | state = true |
) | [inline] |
{m_transient = state;}
| bool IsTemporary | ( | ) | const [inline] |
{ return m_temporary; }
| void SetTemporary | ( | bool | state = true |
) | [inline] |
{ m_temporary = state; }
| virtual void SetExtents | ( | TimeValue | t, |
| Point3 | halfbox | ||
| ) | [pure virtual] |
| virtual Point3 GetExtents | ( | TimeValue | t | ) | [pure virtual] |
