DWFToolkit::DWFModelScene Class Reference

Inheritance diagram for DWFToolkit::DWFModelScene:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFModelScene:

Collaboration graph
[legend]
List of all members.

Detailed Description

Since:
7.2

Definition at line 244 of file ModelScene.h.

Public Types

enum  teAttributeType {
  eCamera = 0x0001, eColor = 0x0002, eCuttingPlane = 0x0004, eModellingMatrix = 0x0008,
  eTextureMatrix = 0x0010, eVisibility = 0x0020, eInstanceVisibility = 0x0040, eInstanceTransparency = 0x0080,
  eGeometricVariation = 0x0100, eDisplayMode = 0x0200
}
 Enumeration values that define the various attributes that can be changed on a model scene. More...
enum  teDisplayMode { eShaded = 0x01, eEdges = 0x02 }
 Enumeration values that define the display modes that can set on the model scene. The display modes can be combined to create new display modes. More...

Public Member Functions

_DWFTK_API DWFModelScene () throw ()
virtual _DWFTK_API ~DWFModelScene () throw ()
virtual _DWFTK_API void setCurrentInstance (const DWFInstance &rInstance) throw ( DWFException )
virtual _DWFTK_API void setCurrentInstanceID (const DWFString &zID) throw ( DWFException )
virtual _DWFTK_API void setCamera (const W3DCamera &rCamera, bool bSmoothTransition) throw ( DWFException )
virtual _DWFTK_API TK_Color & getColorHandler () throw ( DWFException )
virtual _DWFTK_API TK_Cutting_Plane & getCuttingPlaneHandler () throw ( DWFException )
virtual _DWFTK_API TK_Matrix & getModellingMatrixHandler () throw ( DWFException )
virtual _DWFTK_API TK_Matrix & getTextureMatrixHandler () throw ( DWFException )
virtual _DWFTK_API TK_Visibility & getVisibilityHandler () throw ( DWFException )
virtual _DWFTK_API void setGeometricVariationIndex (unsigned int nIndex) throw ( DWFException )
virtual _DWFTK_API void setVisibility (bool bVisibility) throw ( DWFException )
virtual _DWFTK_API void setTransparency (bool bTransparency) throw ( DWFException )
virtual _DWFTK_API void lockAttribute (teAttributeType eType) throw ( DWFException )
virtual _DWFTK_API void unlockAttribute (teAttributeType eType) throw ( DWFException )
virtual _DWFTK_API void setDisplayMode (unsigned int nDisplayMode) throw ( DWFException )
virtual _DWFTK_API void open () throw ( DWFException )
virtual _DWFTK_API void close () throw ( DWFException )
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Protected Attributes

std::deque< DWFModelSceneChangeHandler * > _oSerializableSceneAPI
bool _bOpenInstance
DWFString _zOpenInstanceID
bool _bInstancePreviouslyOpen
DWFString _zPreviousInstanceID

Classes

class  _W3DAttributeLock
class  _W3DCamera
class  _W3DColor
class  _W3DCuttingPlanes
class  _W3DDisplayMode
class  _W3DInstance
class  _W3DInstanceOptions
class  _W3DTransform
class  _W3DVisibility
class  _W3DXMLPseudoHandler


Member Enumeration Documentation

enum DWFToolkit::DWFModelScene::teAttributeType
 

Enumeration values that define the various attributes that can be changed on a model scene.

Enumerator:
eCamera  Camera
eColor  Color
eCuttingPlane  Cutting Plane
eModellingMatrix  Modelling Matrix
eTextureMatrix  Texture Matrix
eVisibility  Visibility
eInstanceVisibility  InstanceVisibility
eInstanceTransparency  InstanceTransparency
eGeometricVariation  Geometric Variation
eDisplayMode  Display Mode

Definition at line 260 of file ModelScene.h.

enum DWFToolkit::DWFModelScene::teDisplayMode
 

Enumeration values that define the display modes that can set on the model scene. The display modes can be combined to create new display modes.

Enumerator:
eShaded  Shaded
eEdges  Edges

Definition at line 320 of file ModelScene.h.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFModelScene::DWFModelScene  )  throw ()
 

Constructor

Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFModelScene::~DWFModelScene  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFModelScene::close  )  throw ( DWFException ) [virtual]
 

This method completes model changes. This method must called after all scene changes have been recorded.

Exceptions:
DWFException 

virtual _DWFTK_API TK_Color& DWFToolkit::DWFModelScene::getColorHandler  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API TK_Cutting_Plane& DWFToolkit::DWFModelScene::getCuttingPlaneHandler  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API TK_Matrix& DWFToolkit::DWFModelScene::getModellingMatrixHandler  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API TK_Matrix& DWFToolkit::DWFModelScene::getTextureMatrixHandler  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API TK_Visibility& DWFToolkit::DWFModelScene::getVisibilityHandler  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::lockAttribute teAttributeType  eType  )  throw ( DWFException ) [virtual]
 

This method will cause attributes on this segment to override local attributes on child segments.

Parameters:
eType The attribute to be locked.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::open  )  throw ( DWFException ) [inline, virtual]
 

This method initiates model changes. This method must called before any scene changes have been recorded.

Exceptions:
DWFException 

Definition at line 488 of file ModelScene.h.

virtual _DWFTK_API void DWFToolkit::DWFModelScene::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setCamera const W3DCamera &  rCamera,
bool  bSmoothTransition
throw ( DWFException ) [virtual]
 

Sets the current view

Parameters:
rCamera The camera parameters for the view
bSmoothTransition Specifies whether the camera transition must be done smoothly or not
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setCurrentInstance const DWFInstance rInstance  )  throw ( DWFException ) [virtual]
 

Sets the instance on which subsequent attribute changes are to be applied.

Parameters:
rInstance The instance on which subsequent attribute changes are to be applied.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setCurrentInstanceID const DWFString zID  )  throw ( DWFException ) [virtual]
 

Sets the id of the instance on which subsequent attribute changes are to be applied.

Parameters:
zID The id of the instance on which subsequent attribute changes are to be applied.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setDisplayMode unsigned int  nDisplayMode  )  throw ( DWFException ) [virtual]
 

Sets the current display mode

Parameters:
nDisplayMode A combination of one or more enumeration values that specifies the display mode.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setGeometricVariationIndex unsigned int  nIndex  )  throw ( DWFException ) [virtual]
 

Sets the index of the geometric variation to activate.

Parameters:
nIndex Sets the index of the geometric variation to activate.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setTransparency bool  bTransparency  )  throw ( DWFException ) [virtual]
 

Sets the transparency of the current instance

Parameters:
bTransparency If true turns the transparency of the instance ON, else turns the transparency off.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::setVisibility bool  bVisibility  )  throw ( DWFException ) [virtual]
 

Sets the visibility of the current instance

Parameters:
bVisibility If true turns the visibility of the instance ON, else turns the visibility off.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFModelScene::unlockAttribute teAttributeType  eType  )  throw ( DWFException ) [virtual]
 

This method will cause attribute locking to be removed.

Parameters:
eType The attribute to be unlocked.
Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:41 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5