TBasicWireframeSet Class Reference
[Base Classes for plugins]

Inheritance diagram for TBasicWireframeSet:

I3DExWF I3DExWireFrameSet IMCUnknown IMCUnknown List of all members.

Public Member Functions

virtual MCErr MCCOMAPI QueryInterface (const MCIID &riid, void **ppvObj)=0
virtual I3DExWireFrameSet
*MCCOMAPI 		GetNewInterface ()
virtual I3DExWireFrame *MCCOMAPI GetDeprecatedInterface ()
virtual MCCOMErr MCCOMAPI TrackWireFrame (I3DShWireFrameSet *wireFrame, int16 proj, I3DShTreeElement *tree, const TWFHitInfo &handle, const TRACKINFO &startinfo, const TRACKINFO &previnfo, const TRACKINFO &nextinfo)
virtual MCCOMErr MCCOMAPI DataToWireFrame (I3DShWireFrameSet *wireFrame, int16 proj, I3DShTreeElement *tree)
virtual MCCOMErr MCCOMAPI WireFrameToData (I3DShWireFrameSet *wireFrame, int16 proj, I3DShTreeElement *tree)
virtual MCCOMErr MCCOMAPI GetWireFrameBBox (TBBox3D *outBBox, int16 proj, I3DShTreeElement *tree)
 the following methods MUST BE common to I3DExWireFrameSet and I3DExWireFrame:
virtual MCCOMErr MCCOMAPI GetGlobalTransform (I3DShTreeElement *tree, TTreeTransform &outTransform)
virtual void MCCOMAPI ShowWFTools (boolean show)
 Tells your wireframe to show or not its tools (if any).
virtual boolean MCCOMAPI HandlesTool (int16 inTool)
virtual boolean MCCOMAPI TestHit (const Ray3D &localRay, TWFHitInfo &outInfo)
virtual void MCCOMAPI GetActionName (TMCString &outName)

Detailed Description

Basic Wireframe Set class. Derive from this for a default implementation of I3DExWF and I3DExWireFrameSet. Your class must also inherit from another TBasic* class, and be sure to add a call to TBasicWireframeSet::QueryInterface before you call TBasicUnknown::QueryInterface

See also:
I3DExWF, I3DExWireFrameSet

Member Function Documentation

virtual MCCOMErr MCCOMAPI TBasicWireframeSet::DataToWireFrame (  I3DShWireFrameSet *  wireFrame,
int16  proj,
I3DShTreeElement *  tree
)  [virtual]
 

Implements I3DExWireFrameSet.

virtual void MCCOMAPI TBasicWireframeSet::GetActionName (  TMCString &  outName  )  [inline, virtual]
 

Returns the name of the action associated with TrackWireFrame (displayed by undo) If that function is not implemented, the default name is "Move"

Parameters:
outName The name of the action.

Implements I3DExWireFrameSet.

virtual I3DExWireFrame* MCCOMAPI TBasicWireframeSet::GetDeprecatedInterface (   )  [inline, virtual]
 

Implements I3DExWF.

virtual MCCOMErr MCCOMAPI TBasicWireframeSet::GetGlobalTransform (  I3DShTreeElement *  tree,
TTreeTransform &  outTransform
)  [inline, virtual]
 

Gets the transform to apply to the wireframe data to convert it into global space

Note:
Only implement this method if your wf data is not stored in the tree's local coordinates
Parameters:
tree the tree that has the wireframe
outTransform the wfdata to world transform
Returns:
MC_S_OK if outTransform is set, or MC_E_NOTIMPL to use the default

Implements I3DExWireFrameSet.

virtual I3DExWireFrameSet* MCCOMAPI TBasicWireframeSet::GetNewInterface (   )  [inline, virtual]
 

Implements I3DExWF.

virtual MCCOMErr MCCOMAPI TBasicWireframeSet::GetWireFrameBBox (  TBBox3D *  outBBox,
int16  proj,
I3DShTreeElement *  tree
)  [virtual]
 

the following methods MUST BE common to I3DExWireFrameSet and I3DExWireFrame:

Implements I3DExWF.

virtual boolean MCCOMAPI TBasicWireframeSet::HandlesTool (  int16  inTool  )  [virtual]
 

Implements I3DExWF.

virtual MCErr MCCOMAPI TBasicWireframeSet::QueryInterface (  const MCIID &  riid,
void **  ppvObj
)  [pure virtual]
 

Check if the object supports a given interface and returns a pointer to that interface if it does. Note that QueryInterface will increment the reference count of the object by one if the interface is found.

Parameters:
riid GUID of the interface
ppvObj A pointer to the pointer being returned.

Implements IMCUnknown.

virtual void MCCOMAPI TBasicWireframeSet::ShowWFTools (  boolean  show  )  [inline, virtual]
 

Tells your wireframe to show or not its tools (if any).

Implements I3DExWF.

virtual boolean MCCOMAPI TBasicWireframeSet::TestHit (  const Ray3D &  localRay,
TWFHitInfo &  outInfo
)  [inline, virtual]
 

For wireframes that consider themselves surfaces (eg scale manipulators) computes the intersection of the given ray and the wire's surface

Parameters:
localRay The ray with which the intersection is calculated.
outInfo The info about the intersection if there is one.
Returns:
true is there is an intersection and fills outInfo

Implements I3DExWireFrameSet.

virtual MCCOMErr MCCOMAPI TBasicWireframeSet::TrackWireFrame (  I3DShWireFrameSet *  wireFrame,
int16  proj,
I3DShTreeElement *  tree,
const TWFHitInfo &  handle,
const TRACKINFO &  startinfo,
const TRACKINFO &  previnfo,
const TRACKINFO &  nextinfo
)  [virtual]
 

Implements I3DExWireFrameSet.

virtual MCCOMErr MCCOMAPI TBasicWireframeSet::WireFrameToData (  I3DShWireFrameSet *  wireFrame,
int16  proj,
I3DShTreeElement *  tree
)  [virtual]
 

Implements I3DExWireFrameSet.

The documentation for this class was generated from the following file:
Generated on Mon Mar 14 12:29:07 2005 for Carrara SDK Doc by  doxygen 1.3.9.1