Panda3D
|
A single molecular field of a Distributed Class, as read from a .dc file. More...
#include <pandadoc.hpp>
Public Member Functions | |
DCAtomicField | getAtomic (int n) |
Returns the nth atomic field that makes up this molecular field. | |
int | getNumAtomics () |
Returns the number of atomic fields that make up this molecular field. | |
![]() | |
Datagram | aiFormatUpdate (DOIDTYPE do_id, CHANNELTYPE to_id, CHANNELTYPE from_id, object args) |
Generates a datagram containing the message necessary to send an update for the indicated distributed object from the AI. | |
Datagram | aiFormatUpdateMsgType (DOIDTYPE do_id, CHANNELTYPE to_id, CHANNELTYPE from_id, int msg_type, object args) |
Generates a datagram containing the message necessary to send an update, with the msg type, for the indicated distributed object from the AI. | |
DCAtomicField | asAtomicField () |
Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL. | |
const DCAtomicField | asAtomicField () |
Returns the same field pointer converted to an atomic field pointer, if this is in fact an atomic field; otherwise, returns NULL. | |
DCField | asField () |
const DCField | asField () |
DCMolecularField | asMolecularField () |
Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL. | |
const DCMolecularField | asMolecularField () |
Returns the same field pointer converted to a molecular field pointer, if this is in fact a molecular field; otherwise, returns NULL. | |
DCParameter | asParameter () |
const DCParameter | asParameter () |
Datagram | clientFormatUpdate (DOIDTYPE do_id, object args) |
Generates a datagram containing the message necessary to send an update for the indicated distributed object from the client. | |
str | formatData (VectorUchar packed_data, bool show_field_names) |
Given a blob that represents the packed data for this field, returns a string formatting it for human consumption. | |
DCClass | getClass () |
Returns the DCClass pointer for the class that contains this field. | |
VectorUchar | getDefaultValue () |
Returns the default value for this field. | |
int | getNumber () |
Returns a unique index number associated with this field. | |
bool | hasDefaultValue () |
Returns true if a default value has been explicitly established for this field, false otherwise. | |
bool | isAirecv () |
Returns true if the "airecv" flag is set for this field, false otherwise. | |
bool | isBogusField () |
Returns true if the field has been flagged as a bogus field. | |
bool | isBroadcast () |
Returns true if the "broadcast" flag is set for this field, false otherwise. | |
bool | isClrecv () |
Returns true if the "clrecv" flag is set for this field, false otherwise. | |
bool | isClsend () |
Returns true if the "clsend" flag is set for this field, false otherwise. | |
bool | isDb () |
Returns true if the "db" flag is set for this field, false otherwise. | |
bool | isOwnrecv () |
Returns true if the "ownrecv" flag is set for this field, false otherwise. | |
bool | isOwnsend () |
Returns true if the "ownsend" flag is set for this field, false otherwise. | |
bool | isRam () |
Returns true if the "ram" flag is set for this field, false otherwise. | |
bool | isRequired () |
Returns true if the "required" flag is set for this field, false otherwise. | |
output (Ostream out) | |
Write a string representation of this instance to <out>. | |
bool | packArgs (DCPacker packer, object sequence) |
Packs the Python arguments from the indicated tuple into the packer. | |
VectorUchar | parseString (str formatted_string) |
Given a human-formatted string (for instance, as returned by format_data(), above) that represents the value of this field, parse the string and return the corresponding packed data. | |
receiveUpdate (DCPacker packer, object distobj) | |
Extracts the update message out of the datagram and applies it to the indicated object by calling the appropriate method. | |
object | unpackArgs (DCPacker packer) |
Unpacks the values from the packer, beginning at the current point in the unpack_buffer, into a Python tuple and returns the tuple. | |
bool | validateRanges (VectorUchar packed_data) |
Verifies that all of the packed values in the field data are within the specified ranges and that there are no extra bytes on the end of the record. | |
write (Ostream out, int indent_level) | |
Write a string representation of this instance to <out>. | |
![]() | |
DCClassParameter | asClassParameter () |
const DCClassParameter | asClassParameter () |
DCField | asField () |
const DCField | asField () |
DCSwitchParameter | asSwitchParameter () |
const DCSwitchParameter | asSwitchParameter () |
bool | checkMatch (const DCPackerInterface other) |
Returns true if the other interface is bitwise the same as this one–that is, a uint32 only matches a uint32, etc. | |
bool | checkMatch (str description, DCFile dcfile) |
Returns true if this interface is bitwise the same as the interface described with the indicated formatted string, e.g. | |
int | findSeekIndex (str name) |
Returns the index number to be passed to a future call to DCPacker::seek() to seek directly to the named field without having to look up the field name in a table later, or -1 if the named field cannot be found. | |
str | getName () |
Returns the name of this field, or empty string if the field is unnamed. | |
![]() | |
bool | compareKeywords (const DCKeywordList other) |
Returns true if this list has the same keywords as the other list, false if some keywords differ. | |
const DCKeyword | getKeyword (int n) |
Returns the nth keyword in the list. | |
const DCKeyword | getKeywordByName (str name) |
Returns the keyword in the list with the indicated name, or NULL if there is no keyword in the list with that name. | |
int | getNumKeywords () |
Returns the number of keywords in the list. | |
bool | hasKeyword (const DCKeyword keyword) |
Returns true if this list includes the indicated keyword, false otherwise. | |
bool | hasKeyword (str name) |
Returns true if this list includes the indicated keyword, false otherwise. | |
A single molecular field of a Distributed Class, as read from a .dc file.
This represents a combination of two or more related atomic fields, that will often be treated as a unit.
DCAtomicField getAtomic | ( | int | n | ) |
Returns the nth atomic field that makes up this molecular field.
This may or may not be a field of this particular class; it might be defined in a parent class.
int getNumAtomics | ( | ) |
Returns the number of atomic fields that make up this molecular field.