TK_Linear_Pattern Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Linear_Pattern:

Inheritance graph
[legend]
Collaboration diagram for TK_Linear_Pattern:

Collaboration graph
[legend]
List of all members.

Detailed Description

TK_Linear_Pattern provided support for writing/reading the TKE_Line_Pattern and TKE_Edge_Pattern opcode objects, which represent a composite of the dashing pattern, cap style, and join style. This has been superceded by TK_Named.

Definition at line 4631 of file BOpcodeHandler.h.

Public Member Functions

 TK_Linear_Pattern (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetPattern (int p) alter
int GetPattern (void) const

Protected Attributes

unsigned short m_pattern
 internal use


Constructor & Destructor Documentation

TK_Linear_Pattern::TK_Linear_Pattern unsigned char  opcode  )  [inline]
 

constructor

Definition at line 4641 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Linear_Pattern::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
const [virtual]
 

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

int TK_Linear_Pattern::GetPattern void   )  const [inline]
 

Returns the pattern value

Definition at line 4654 of file BOpcodeHandler.h.

TK_Status TK_Linear_Pattern::Read BStreamFileToolkit tk  )  [virtual]
 

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Linear_Pattern::SetPattern int  p  )  [inline]
 

Sets the pattern value

Definition at line 4652 of file BOpcodeHandler.h.

TK_Status TK_Linear_Pattern::Write BStreamFileToolkit tk  )  [virtual]
 

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


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