Public Member Functions | Static Public Member Functions

MSPluginShape Class Reference

Search for all occurrences

#include <mxsPlugin.h>

Inheritance diagram for MSPluginShape:
Inheritance graph
[legend]

List of all members.

Public Member Functions
  MSPluginShape ()
  MSPluginShape (MSPluginClass *pc, BOOL loading)
  ~MSPluginShape ()
RefTargetHandle  Clone (RemapDir &remap)
  This method is used by 3ds Max to clone an object.
int  IsRenderable ()
  Indicates whether the object may be rendered.
Mesh *  GetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
  This method should be implemented by all renderable GeomObjects.
void  InitNodeName (MSTR &s)
  This is the default name of the node when it is created.
SClass_ID  SuperClassID ()
  Retrieves a constant representing the type of the plugin.
int  IntersectRay (TimeValue t, Ray &ray, float &at, Point3 &norm)
  Computes the intersection point of the ray passed and the shape.
int  NumberOfVertices (TimeValue t, int curve=-1)
  This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.
int  NumberOfCurves ()
  Returns the number of polygons in the shape.
BOOL  CurveClosed (TimeValue t, int curve)
  This method is called to determine if the specified curve of the shape is closed at the time passed.
Point3  InterpCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)
  This method returns a point interpolated on the entire curve.
Point3  TangentCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)
  This method returns a tangent vector interpolated on the entire curve.
float  LengthOfCurve (TimeValue t, int curve)
  Returns the length of the specified curve.
int  NumberOfPieces (TimeValue t, int curve)
  Returns the number of sub-curves in a curve.
Point3  InterpPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)
  This method returns the interpolated point along the specified sub-curve (segment).
Point3  TangentPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)
  Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.
BOOL  CanMakeBezier ()
  This method is called to determine if the shape can be converted to a bezier representation.
void  MakeBezier (TimeValue t, BezierShape &shape)
  Creates the bezier representation of the shape.
ShapeHierarchy &  OrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)
  This method is called to prepare the shape for lofting, extrusion, etc.
void  MakePolyShape (TimeValue t, PolyShape &shape, int steps=PSHAPE_BUILTIN_STEPS, BOOL optimize=FALSE)
  Create a PolyShape representation with optional fixed steps.
int  MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)
  This method generates a mesh capping info for the shape.
int  MakeCap (TimeValue t, PatchCapInfo &capInfo)
  This method creates a patch cap info out of the shape.
MtlID  GetMatID (TimeValue t, int curve, int piece)
  This method provides access to the material IDs of the shape.
BOOL  AttachShape (TimeValue t, INode *thisNode, INode *attachNode)
BOOL  HasUVW ()
  It is called to find out if the object is has UVW coordinates.
void  SetGenUVW (BOOL sw)
  This method is called to change the state of its Generate UVW boolean.
IOResult  Save (ISave *isave)
  Implemented by the System.
IOResult  Load (ILoad *iload)
  Implemented by the System.
Class_ID  PreferredCollapseType ()
  Implemented by the System.
BOOL  GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
  Implemented by the System.
void  RescaleWorldUnits (float f)
  Implemented by the System.

Static Public Member Functions
static RefTargetHandle  create (MSPluginClass *pc, BOOL loading)

Constructor & Destructor Documentation

MSPluginShape ( ) [inline] 
: MSPluginObject<ShapeObject>() { sh.New(); }
MSPluginShape ( MSPluginClass *  pc,
BOOL  loading 
)
~MSPluginShape ( ) [inline] 
{ DeleteAllRefsFromMe(); }

Member Function Documentation

static RefTargetHandle create ( MSPluginClass *  pc,
BOOL  loading 
) [static]
Search for all occurrences
RefTargetHandle Clone ( RemapDir &  remap ) [virtual]
Search for all occurrences

This method is used by 3ds Max to clone an object.

See also:
CloneRefHierarchy(), class RemapDir This method is called by 3ds Max to have the plugin clone itself. The plug-in's implementation of this method should copy both the data structure and all the data residing in the data structure of this reference target. The plugin should clone all its references as well. Also, the plug-in's implementation of this method must call BaseClone(). In order for classes derived from this class to clone cleanly, the Clone method should just create the new instance, and then call an implementation of BaseClone that clones the references and copies any other necessary data. For example: 
            class MyDerivedPlugin
                : public MyBasePlugin
            {
                const int MY_REFERENCE = 1;

                ReferenceTarget* Clone(RemapDir& remap)
                {
                    ReferenceTarget* result = new MyDerivedPlugin();
                    BaseClone(this, result, remap);
                    return result;
                }

                void BaseClone(ReferenceTarget* from, ReferenceTarget* to, RemapDir& remap)
                {
                    if (!to || !from || from == to)
                        return;    
                    MyBasePlugin::BaseClone(from, to, remap);
                    to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));
                }
            };

This method should not be directly called by plug-ins. Instead, either RemapDir::CloneRef() or CloneRefHierachy() should be used to perform cloning. These methods ensure that the mapping from the original object to the clone is added to the RemapDir used for cloning, which may be used during backpatch operations

Note:
See the remarks in method BaseClone() below.
Parameters:
remap - A RemapDir instance used for remapping references during a Clone.
Returns:
A pointer to the cloned item.

Reimplemented from ReferenceTarget.

Reimplemented in MSShapeXtnd.

int IsRenderable ( ) [inline, virtual]
Search for all occurrences

Indicates whether the object may be rendered.

Some objects such as construction grids and helpers should not be rendered and can return zero.

Returns:
Nonzero if the object may be rendered; otherwise 0.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::IsRenderable(); }
Mesh* GetRenderMesh ( TimeValue  t,
INode *  inode,
View &  view,
BOOL &  needDelete 
) [inline, virtual]
Search for all occurrences

This method should be implemented by all renderable GeomObjects.

It provides a mesh representation of the object for use by the renderer. Primitives that already have a mesh cached can just return a pointer to it (and set needDelete to FALSE). Implementations of this method which take a long time should periodically call View::CheckForRenderAbort() to see if the user has canceled the render. If canceled, the function can either return NULL, or return a non null pointer with the appropriate value for needDelete. (If needDelete is TRUE a non-null mesh will be deleted.)

Parameters:
t The time to get the mesh.
inode The node in the scene.
view If the renderer calls this method it will pass the view information here. See Class View.
needDelete Set to TRUE if the renderer should delete the mesh, FALSE otherwise.
Returns:
A pointer to the mesh object.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::GetRenderMesh(t, inode, view, needDelete); }
void InitNodeName ( MSTR &  s ) [inline, virtual]
Search for all occurrences

This is the default name of the node when it is created.

Parameters:
s The default name of the node is stored here.

Reimplemented from MSPluginObject< ShapeObject >.

Reimplemented in MSShapeXtnd, and MSObjectXtnd< ShapeObject, MSPluginShape >.

{ ShapeObject::InitNodeName(s); }
SClass_ID SuperClassID ( ) [inline, virtual]
Search for all occurrences

Retrieves a constant representing the type of the plugin.

Returns:
A super class id that uniquely identifies the type (category) of the plugin. Note that several plugin classes can be of the same type, thus return the same super class id. Plugins are uniquely identified by their class ids. List of Super Class IDs.
See also:
SClass_ID

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::SuperClassID(); }
int IntersectRay ( TimeValue  t,
Ray &  ray,
float &  at,
Point3 &  norm 
) [inline, virtual]
Search for all occurrences

Computes the intersection point of the ray passed and the shape.

Note:
This method has a default implementation and it is not necessary to define this method in classes derived from ShapeObject.
Parameters:
t The time to compute the intersection.
ray Ray to intersect.
at The point of intersection.
norm The surface normal at the point of intersection.
Returns:
Nonzero if a point of intersection was found; otherwise 0.

Reimplemented from MSPluginObject< ShapeObject >.

Reimplemented in MSShapeXtnd, and MSObjectXtnd< ShapeObject, MSPluginShape >.

{ return ShapeObject::IntersectRay(t, ray, at, norm); }
int NumberOfVertices ( TimeValue  t,
int  curve = -1 
) [inline, virtual]
Search for all occurrences

This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.

The method is passed a TimeValue and a curve index; if the curve index is <0, the function should return the number of vertices/CVs in the entire shape. Otherwise, it should return the number of vertices/CVs in the specified curve.

Parameters:
t The time at which the number of vertices is to be computed.
curve The curve index. See note above.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::NumberOfVertices(t, curve); } // Informational only, curve = -1: total in all curves
int NumberOfCurves ( ) [inline, virtual]
Search for all occurrences

Returns the number of polygons in the shape.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return 0; }                 // Number of curve polygons in the shape
BOOL CurveClosed ( TimeValue  t,
int  curve 
) [inline, virtual]
Search for all occurrences

This method is called to determine if the specified curve of the shape is closed at the time passed.

Parameters:
t The time to check.
curve The index of the curve to check.
Returns:
TRUE if the curve is closed; otherwise FALSE.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return FALSE; }     // Returns TRUE if the curve is closed
Point3 InterpCurve3D ( TimeValue  t,
int  curve,
float  param,
int  ptype = PARAM_SIMPLE 
) [inline, virtual]
Search for all occurrences

This method returns a point interpolated on the entire curve.

This method returns the point but you don't know which segment the point falls on. See method InterpPiece3D().

Parameters:
t The time to evaluate.
curve The index of the curve to evaluate.
param The 'distance' along the curve where 0 is the start and 1 is the end.
ptype The parameter type for spline interpolation. See List of Parameter Types for Shape Interpolation.
Returns:
The interpolated point on the curve.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return Point3 (0,0,0); }    // Interpolate from 0-1 on a curve
Point3 TangentCurve3D ( TimeValue  t,
int  curve,
float  param,
int  ptype = PARAM_SIMPLE 
) [inline, virtual]
Search for all occurrences

This method returns a tangent vector interpolated on the entire curve.

Also see method TangentPiece3D().

Parameters:
t The time at which to evaluate the curve.
curve The index of the curve to evaluate.
param The 'distance' along the curve where 0.0 is the start and 1.0 is the end. int ptype=PARAM_SIMPLE

The parameter type for spline interpolation. See List of Parameter Types for Shape Interpolation.
Returns:
The tangent vector

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return Point3 (0,0,0); }    // Get tangent at point on a curve
float LengthOfCurve ( TimeValue  t,
int  curve 
) [inline, virtual]
Search for all occurrences

Returns the length of the specified curve.

Note: This method makes no allowance for non-uniform scaling in the object transform. To do that, see the following code fragment (os is the ObjectState with the shape object and xfm is the NodeTM of the shape object node).

    if (os.obj->SuperClassID() == SHAPE_CLASS_ID)
    {
        ShapeObject *sobj;
        sobj = (ShapeObject *) os.obj;
        int cct = sobj->NumberOfCurves();
        PolyShape workShape;
        sobj->MakePolyShape(ip->GetTime(), workShape);
        workShape.Transform(xfm);
        float len = 0.0f;
        for (int i=0; i<cct; i++)
            len += workShape.lines[i].CurveLength();
    }
Parameters:
t The time at which to compute the length.
curve The index of the curve.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return 0.0f; }  // Get the length of a curve
int NumberOfPieces ( TimeValue  t,
int  curve 
) [inline, virtual]
Search for all occurrences

Returns the number of sub-curves in a curve.

Parameters:
t The time at which to check.
curve The index of the curve.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return 0; }   // Number of sub-curves in a curve
Point3 InterpPiece3D ( TimeValue  t,
int  curve,
int  piece,
float  param,
int  ptype = PARAM_SIMPLE 
) [inline, virtual]
Search for all occurrences

This method returns the interpolated point along the specified sub-curve (segment).

For example consider a shape that is a single circle with four knots. If you called this method with curve=0 and piece=0 and param=0.0 you'd get back the point at knot 0. If you passed the same parameters except param=1.0 you'd get back the point at knot 1.

Parameters:
t The time to evaluate the sub-curve.
curve The curve to evaluate.
piece The segment to evaluate.
param The position along the curve to return where 0.0 is the start and 1.0 is the end.
ptype The parameter type for spline interpolation. See List of Parameter Types for Shape Interpolation.
Returns:
The point in world space.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return Point3 (0,0,0); }  // Interpolate from 0-1 on a sub-curve
Point3 TangentPiece3D ( TimeValue  t,
int  curve,
int  piece,
float  param,
int  ptype = PARAM_SIMPLE 
) [inline, virtual]
Search for all occurrences

Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.

Parameters:
t The time to evaluate the sub-curve.
curve The curve to evaluate.
piece The sub-curve (segment) to evaluate.
param The position along the curve to return where 0 is the start and 1 is the end.
ptype The parameter type for spline interpolation. See List of Parameter Types for Shape Interpolation.
Returns:
The tangent vector.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return Point3 (0,0,0); }         // Get tangent on a sub-curve
BOOL CanMakeBezier ( ) [inline, virtual]
Search for all occurrences

This method is called to determine if the shape can be converted to a bezier representation.

Returns:
TRUE if the shape can turn into a bezier representation; otherwise FALSE.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::CanMakeBezier(); }                  // Return TRUE if can turn into a bezier representation
void MakeBezier ( TimeValue  t,
BezierShape &  shape 
) [inline, virtual]
Search for all occurrences

Creates the bezier representation of the shape.

Parameters:
t The time to convert.
shape The bezier representation is stored here.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ ShapeObject::MakeBezier(t, shape); }     // Create the bezier representation
ShapeHierarchy& OrganizeCurves ( TimeValue  t,
ShapeHierarchy *  hier = NULL 
) [inline, virtual]
Search for all occurrences

This method is called to prepare the shape for lofting, extrusion, etc.

This methods looks at the shape organization, and puts together a shape hierarchy. This provides information on how the shapes are nested.

Parameters:
t The time to organize the curves.
hier This class provides information about the hierarchy. See Class ShapeHierarchy.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return sh; }       // Ready for lofting, extrusion, etc.
void MakePolyShape ( TimeValue  t,
PolyShape &  shape,
int  steps = PSHAPE_BUILTIN_STEPS,
BOOL  optimize = FALSE 
) [inline, virtual]
Search for all occurrences

Create a PolyShape representation with optional fixed steps.

Parameters:
t The time to make the PolyShape.
shape The PolyShape representation is stored here.
steps The number of steps between knots. Values >=0 indicates the use of fixed steps:

PSHAPE_BUILTIN_STEPS
Use the shape's built-in steps/adaptive settings (default).

PSHAPE_ADAPTIVE_STEPS
Force adaptive steps.
optimize If TRUE intermediate steps are removed from linear segments.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ } // Create a PolyShape representation with optional fixed steps & optimization
int MakeCap ( TimeValue  t,
MeshCapInfo &  capInfo,
int  capType 
) [inline, virtual]
Search for all occurrences

This method generates a mesh capping info for the shape.

Parameters:
t The time to create the cap info.
capInfo The cap info to update.
capType See Shape Capping Types.
Returns:
Nonzero if the cap info was generated; otherwise zero.

Implements ShapeObject.

Reimplemented in MSShapeXtnd.

{ return 0; }  // Generate mesh capping info for the shape
int MakeCap ( TimeValue  t,
PatchCapInfo &  capInfo 
) [inline, virtual]
Search for all occurrences

This method creates a patch cap info out of the shape.

Only implement this method if CanMakeBezier() returns TRUE.

Parameters:
t The time to create the cap info.
capInfo The cap info to update.
Returns:
Nonzero if the cap info was generated; otherwise zero.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::MakeCap(t, capInfo); }    // Only implement if CanMakeBezier=TRUE -- Gen patch cap info
MtlID GetMatID ( TimeValue  t,
int  curve,
int  piece 
) [inline, virtual]
Search for all occurrences

This method provides access to the material IDs of the shape.

It returns the material ID of the specified segment of the specified curve of this shape at the time passed. There is a default implementation so there is no need to implement this method if the shape does not support material IDs. Note: typedef unsigned short MtlID;

Parameters:
t The time to evaluate the sub-curve.
curve The zero based index of the curve to evaluate.
piece The sub-curve (segment) to evaluate.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::GetMatID(t, curve, piece); }
BOOL AttachShape ( TimeValue  t,
INode *  thisNode,
INode *  attachNode 
) [inline]
Search for all occurrences

Reimplemented in MSShapeXtnd.

{ return ShapeObject::AttachShape(t, thisNode, attachNode); }   // Return TRUE if attached
BOOL HasUVW ( ) [inline, virtual]
Search for all occurrences

It is called to find out if the object is has UVW coordinates.

This method returns TRUE if the object has UVW coordinates; otherwise FALSE. In 3ds Max 2.0 and later there is code in the renderer that will automatically turn on the UVW coordinates of the base object if UV's are missing (and needed). The base object has to implement two simple methods to make this work: HasUVW() and SetGenUVW(). Developers are encouraged to put these methods in their objects: it makes using the program easier for the user. If they are not implemented, it doesn't cause any real harm: it will just operate as before and put up the missing UVW's message. Here is how the procedural sphere implements these methods:

    BOOL SphereObject::GetGenUVW()
    {
        BOOL genUVs;
        Interval v;
        pblock->GetValue(PB_GENUVS, 0, genUVs, v);
        return genUVs;
    }
    
    void SphereObject::SetGenUVW(BOOL sw)
    {
        if (sw==GetGenUVW()) return;
        pblock->SetValue(PB_GENUVS,0, sw);
    }

Important Note: The pblock->SetValue() will cause a call to NotifyDependents(FOREVER, PART_TEXMAP, REFMSG_CHANGE), which will invalidate the UVW cache. It is essential that this call be made, so if the 'generate UVW' boolean is not handled by a parameter block, then NotifyDependents() needs to be called explicitly. Also Note: For "modifiable objects" that pass up the pipeline getting modified, such as TriObject, EditTriObject, etc., which cannot generate their own UVWs, but can carry them in their data structures, only this HasUVW() method needs to be implemented. For example, here is the implementation for TriObject: BOOL TriObject::HasUVW() { return mesh.tvFace?1:0; }

Reimplemented from MSPluginObject< ShapeObject >.

Reimplemented in MSShapeXtnd, and MSObjectXtnd< ShapeObject, MSPluginShape >.

{ return ShapeObject::HasUVW(); }
void SetGenUVW ( BOOL  sw ) [inline, virtual]
Search for all occurrences

This method is called to change the state of its Generate UVW boolean.

If the state changes, the object must send a REFMSG_CHANGE up the pipeline by calling NotifyDependents(). This applies to map channel 1.

Parameters:
sw The new state for the generate UVW flag.

Reimplemented from MSPluginObject< ShapeObject >.

Reimplemented in MSShapeXtnd, and MSObjectXtnd< ShapeObject, MSPluginShape >.

{ ShapeObject::SetGenUVW(sw); }
IOResult Save ( ISave *  isave ) [inline, virtual]
Search for all occurrences

Implemented by the System.

This method handles the storage of the data contained within the ShapeObject. In order to properly store this information, classes which subclass off of ShapeObject need to call this methods before storing their information.

Parameters:
isave An interface for saving data. See Class ISave.

Reimplemented from MSPluginObject< ShapeObject >.

Reimplemented in MSShapeXtnd.

{ MSPlugin::Save(isave); return ShapeObject::Save(isave); }
IOResult Load ( ILoad *  iload ) [inline, virtual]
Search for all occurrences

Implemented by the System.

This method handles the loading of the data contained within the ShapeObject. In order to properly load this information, classes which subclass off of ShapeObject need to call this methods before loading their information.

Parameters:
iload An interface for loading data. See Class ILoad.

Reimplemented from MSPluginObject< ShapeObject >.

Reimplemented in MSShapeXtnd.

{  MSPlugin::Load(iload); return ShapeObject::Load(iload); }
Class_ID PreferredCollapseType ( ) [inline, virtual]
Search for all occurrences

Implemented by the System.

This is an implementation of the Object method. It simply returns splineShapeClassID.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ return ShapeObject::PreferredCollapseType(); }
BOOL GetExtendedProperties ( TimeValue  t,
MSTR &  prop1Label,
MSTR &  prop1Data,
MSTR &  prop2Label,
MSTR &  prop2Data 
) [inline, virtual]
Search for all occurrences

Implemented by the System.

This is an implementation of the Object method. It fills in the property fields with the number of vertices and curves in the shape.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

                        { return ShapeObject::GetExtendedProperties(t, prop1Label, prop1Data, prop2Label, prop2Data); }
void RescaleWorldUnits ( float  f ) [inline, virtual]
Search for all occurrences

Implemented by the System.

Objects derived from this class which have RescaleWorldUnits methods implemented need to call this method. The following example is the SplineShape implementation of this method from core.

    void SplineShape::RescaleWorldUnits(float f)
    {
        if (TestAFlag(A_WORK1))
            return;
    // Call the base class's rescale (this sets the A_WORK1 flag)
        ShapeObject::RescaleWorldUnits(f);
    // Now rescale stuff inside our data structures
        Matrix3 stm = ScaleMatrix(Point3(f, f, f));
        shape.Transform(stm);
    }

Note that the A_WORK1 flags is tested first to be sure it isn't processing the rescale twice. The code then calls ShapeObject::RescaleWorldUnits, which sets the A_WORK1 flag and performs the necessary rescale methods for all references for the object, and scales the renderable thickness value.

Parameters:
f The parameter to scale.

Reimplemented from ShapeObject.

Reimplemented in MSShapeXtnd.

{ ShapeObject::RescaleWorldUnits(f); }
Generated on Fri Sep 23 2011 17:51:37 by doxygen 1.7.3
Please send us your comment about this page

MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape
MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape MSPluginShape