Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

BOpcodeHandler.h File Reference


Detailed Description

Contains datatypes which are used by BBaseOpcodeHandler.

Definition in file BOpcodeHandler.h.

#include "dwf/Toolkit.h"
#include "dwf/w3dtk/BStreamFileToolkit.h"
#include "dwf/w3dtk/W3DOpcodeHandler.h"
#include "BPolyhedron.h"

Go to the source code of this file.

Defines

#define IMPLEMENT_CLONE(class_name)
 macro to simplify normal implementation of the Clone function
#define IMPLEMENT_CLONE_OPCODE(class_name)
 a version of IMPLEMENT_CLONE for the classes that need to know the opcode
#define TKLOD_ESCAPE   255
 terminates the list of all LOD levels. TKE_Termination could not be used, since 0 is a valid value for LOD level.
#define TKO_Rendo_Extended   0x80000000
#define NC_HAS_WEIGHTS   0x01
 an array of floats for the weights is specified with the TK_NURBS_Curve
#define NC_HAS_KNOTS   0x02
 an array of floats for the knots is specified with the TK_NURBS_Curve
#define NC_HAS_START   0x04
 a float is specified for where the TK_NURBS_Curve starts in parametric [0,1] space
#define NC_HAS_END   0x08
 a float is specified for where the TK_NURBS_Curve ends in parametric [0,1] space
#define NS_HAS_WEIGHTS   0x01
 an array of floats for the weights is specified with the TK_NURBS_Surface
#define NS_HAS_KNOTS   0x02
 an array of floats for the knots is specified with the TK_NURBS_Surface
#define NS_HAS_TRIMS   0x04
 the TK_NURBS_Surface contains a list of trims
#define NS_TRIM_END   0
 terminates an NS_TRIM_COLLECTION if one is active, otherwise terminates the list of trims
#define NS_TRIM_POLY   1
 the next trim is a polyline (closed automatically if not already a closed loop)
#define NS_TRIM_CURVE   2
 the next trim is a nurbs curve in parametric space
#define NS_TRIM_COLLECTION   3
 all trim objects up to the next NS_TRIM_END should be combined as one.
#define NS_TRIM_LAST_KNOWN_TYPE   3
 the last known trim type defined as of the current version of the toolkit
#define NS_TRIM_KEEP   0x01
 instead of the usual cutting away the enclosed area, cut away everything but
#define NS_TRIM_HAS_WEIGHTS   0x02
 applies only to trims of type NS_TRIM_CURVE: an array of floats for the weights is specified with the trim curve
#define NS_TRIM_HAS_KNOTS   0x04
 applies only to trims of type NS_TRIM_CURVE: an array of floats for the knots is specified with the trim curve

Enumerations

enum  TKE_Object_Types
 Opcodes stored in the file. More...
enum  Instance_Options
enum  TKO_Geometry_Bits
enum  TKO_Color_Channels
enum  TKO_Rendering_Option_Bits
enum  TKO_Attribute_Lock_Bits
enum  TKO_Heuristic_Bits
enum  TKO_Enumerations
enum  TKO_Generic_Size_Units
enum  TKO_Camera_Projection
enum  TKO_Font_Options {
  TKO_Font_Names = 0x0001, TKO_Font_Size = 0x0002, TKO_Font_Size_Tolerance = 0x0004, TKO_Font_Transforms = 0x0008,
  TKO_Font_Rotation = 0x0010, TKO_Font_Slant = 0x0020, TKO_Font_Width_Scale = 0x0040, TKO_Font_Extended = 0x0080,
  TKO_Font_Extra_Space = 0x0100, TKO_Font_Line_Spacing = 0x0200, TKO_Font_Outline = 0x0400, TKO_Font_Underline = 0x0800,
  TKO_Font_Strikethrough = 0x1000, TKO_Font_Overline = 0x2000
}
enum  TKO_Font_Size_Units
enum  TKO_Font_Transforms { TKO_Font_Transform_Position_Only = 0, TKO_Font_Transform_Full = 1 }
enum  TKO_Bounding_Type_Options
 Handles the TKE_Bounding and TKE_Bounding_Info opcodes. More...
enum  TKO_Spot_Light_Options
enum  TKO_Text_Encodings
enum  TKO_Font_Type
 Handles the TKE_Font opcodes. More...
enum  TKO_Image_Formats
enum  TKO_Compression
enum  TKO_Texture_Option_Bits
enum  TKO_Texture_Param_Sources
enum  TKO_Texture_Param_Functions
enum  TKO_Texture_Layouts
enum  TKO_Texture_Tilings
enum  TKO_Texture_Filters
enum  TKO_Texture_Channel_Mappings
enum  TKO_Clip_Region_Options { TKO_Clip_Region_Window_Space = 0x01 }


Define Documentation

#define TKO_Rendo_Extended   0x80000000
 

Extended bit for Rendering Options


Enumeration Type Documentation

enum Instance_Options
 

options for the TKE_Repeat_Object opcode

Definition at line 1087 of file BOpcodeHandler.h.

enum TKE_Object_Types
 

Opcodes stored in the file.

Each piece of logical information in the HOOPS Stream File is represented by an opcode. The opcode along with its data constitutes an 'opcode object'

Definition at line 575 of file BOpcodeHandler.h.

enum TKO_Attribute_Lock_Bits
 

Represents attribute lock types

Definition at line 1994 of file BOpcodeHandler.h.

enum TKO_Bounding_Type_Options
 

Handles the TKE_Bounding and TKE_Bounding_Info opcodes.

Defines the class of bounding volume that is specified

Definition at line 3432 of file BOpcodeHandler.h.

enum TKO_Camera_Projection
 

Defines camera projection

Definition at line 3116 of file BOpcodeHandler.h.

enum TKO_Clip_Region_Options
 

options for TKE_Clip_Region opcode

Enumeration values:
TKO_Clip_Region_Window_Space  clip region is to be specified in window space {[0..1],[0..1]}. Default is world space

Definition at line 4970 of file BOpcodeHandler.h.

enum TKO_Color_Channels
 

Defines color channels

Definition at line 1338 of file BOpcodeHandler.h.

enum TKO_Compression
 

Defines compression type

Definition at line 4547 of file BOpcodeHandler.h.

enum TKO_Enumerations
 

Defines the values for the TK_Enumerated forms used by the HOOPS 3DGS

Definition at line 2726 of file BOpcodeHandler.h.

enum TKO_Font_Options
 

When written to m_mask, defines which font options are present in the current opcode (all others are ignored) When written to m_value, defines which font options are turned on

Enumeration values:
TKO_Font_Names  the name of the font (i.e. which font to use)
TKO_Font_Size  the size at which to draw characters
TKO_Font_Size_Tolerance  the size tolerance outside of which fonts must be regenerated
TKO_Font_Transforms  transformation mode (set with a bit from TKO_Font_Transforms)

Defines font transform mode for the TKE_Text_Font opcode. There is no need for an "off" because that would be specified by m_value.

TKO_Font_Rotation  character rotation, specified in degrees
TKO_Font_Slant  character slant
TKO_Font_Width_Scale  scale factor for width
TKO_Font_Extended  extends font options to a second byte
TKO_Font_Extra_Space  in addition to the spacing specified within the font itself, the extra space to add between characters
TKO_Font_Line_Spacing  extra spacing between lines
TKO_Font_Outline  draw only the outline (i.e. don't fill)
TKO_Font_Underline  add an underline to the font
TKO_Font_Strikethrough  add a strikethrough to the font
TKO_Font_Overline  add an overline to the font

Definition at line 3258 of file BOpcodeHandler.h.

enum TKO_Font_Size_Units
 

Defines the size units used for fonts

Definition at line 3278 of file BOpcodeHandler.h.

enum TKO_Font_Transforms
 

Enumeration values:
TKO_Font_Transform_Position_Only  transform position only
TKO_Font_Transform_Full  full transforms

Definition at line 3293 of file BOpcodeHandler.h.

enum TKO_Font_Type
 

Handles the TKE_Font opcodes.

TK_Font provides support for writing/reading the TKE_Font opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph can contain user-defined 'fonts' which provide a desscription of how to draw individual characters in text string.

Definition at line 4437 of file BOpcodeHandler.h.

enum TKO_Generic_Size_Units
 

Defines the units used for general sizing

Definition at line 2860 of file BOpcodeHandler.h.

enum TKO_Geometry_Bits
 

Denotes how various attributes are applied to geometry types

Definition at line 1272 of file BOpcodeHandler.h.

enum TKO_Heuristic_Bits
 

Represents various Heuristics which typically relate to rendering hints or optimizations

Definition at line 2451 of file BOpcodeHandler.h.

enum TKO_Image_Formats
 

Defines image formats

Definition at line 4533 of file BOpcodeHandler.h.

enum TKO_Rendering_Option_Bits
 

Represents various rendering properties

Definition at line 1804 of file BOpcodeHandler.h.

enum TKO_Spot_Light_Options
 

Defines properties of a spot light

Definition at line 3885 of file BOpcodeHandler.h.

enum TKO_Text_Encodings
 

Defines text encoding types

Definition at line 4360 of file BOpcodeHandler.h.

enum TKO_Texture_Channel_Mappings
 

Defines texture channel mappings

Definition at line 4767 of file BOpcodeHandler.h.

enum TKO_Texture_Filters
 

Defines texture interpolation filters

Definition at line 4753 of file BOpcodeHandler.h.

enum TKO_Texture_Layouts
 

Defines texture layouts

Definition at line 4732 of file BOpcodeHandler.h.

enum TKO_Texture_Option_Bits
 

Defines texture options

Definition at line 4679 of file BOpcodeHandler.h.

enum TKO_Texture_Param_Functions
 

Defines texture parameterization functions

Definition at line 4721 of file BOpcodeHandler.h.

enum TKO_Texture_Param_Sources
 

Defines texture parameterization sources

Definition at line 4699 of file BOpcodeHandler.h.

enum TKO_Texture_Tilings
 

Defines texture tilings

Definition at line 4742 of file BOpcodeHandler.h.


Generated on Tue May 17 12:06:00 2005 for Autodesk DWF 3D Toolkit by  doxygen 1.4.1