DCField

from panda3d.direct import DCField
class DCField

Bases: DCPackerInterface, DCKeywordList

A single field of a Distributed Class, either atomic or molecular.

Inheritance diagram

Inheritance diagram of DCField

__init__(*args, **kwargs)
aiFormatUpdate()

C++ Interface: ai_format_update(DCField self, int do_id, long to_id, long from_id, object args)

aiFormatUpdateMsgType()

C++ Interface: ai_format_update_msg_type(DCField self, int do_id, long to_id, long from_id, int msg_type, object args)

ai_format_update()

C++ Interface: ai_format_update(DCField self, int do_id, long to_id, long from_id, object args)

ai_format_update_msg_type()

C++ Interface: ai_format_update_msg_type(DCField self, int do_id, long to_id, long from_id, int msg_type, object args)

asAtomicField()

C++ Interface: as_atomic_field(const DCField self) as_atomic_field(DCField self)

/**

  • Returns the same field pointer converted to an atomic field pointer, if

  • this is in fact an atomic field; otherwise, returns NULL.

*/

/**

  • Returns the same field pointer converted to an atomic field pointer, if

  • this is in fact an atomic field; otherwise, returns NULL.

*/

asField()

C++ Interface: as_field(const DCField self) as_field(DCField self)

/**

*/

/**

*/

asMolecularField()

C++ Interface: as_molecular_field(const DCField self) as_molecular_field(DCField self)

/**

  • Returns the same field pointer converted to a molecular field pointer, if

  • this is in fact a molecular field; otherwise, returns NULL.

*/

/**

  • Returns the same field pointer converted to a molecular field pointer, if

  • this is in fact a molecular field; otherwise, returns NULL.

*/

asParameter()

C++ Interface: as_parameter(const DCField self) as_parameter(DCField self)

/**

*/

/**

*/

as_atomic_field()

C++ Interface: as_atomic_field(const DCField self) as_atomic_field(DCField self)

/**

  • Returns the same field pointer converted to an atomic field pointer, if

  • this is in fact an atomic field; otherwise, returns NULL.

*/

/**

  • Returns the same field pointer converted to an atomic field pointer, if

  • this is in fact an atomic field; otherwise, returns NULL.

*/

as_field()

C++ Interface: as_field(const DCField self) as_field(DCField self)

/**

*/

/**

*/

as_molecular_field()

C++ Interface: as_molecular_field(const DCField self) as_molecular_field(DCField self)

/**

  • Returns the same field pointer converted to a molecular field pointer, if

  • this is in fact a molecular field; otherwise, returns NULL.

*/

/**

  • Returns the same field pointer converted to a molecular field pointer, if

  • this is in fact a molecular field; otherwise, returns NULL.

*/

as_parameter()

C++ Interface: as_parameter(const DCField self) as_parameter(DCField self)

/**

*/

/**

*/

clientFormatUpdate()

C++ Interface: client_format_update(DCField self, int do_id, object args)

client_format_update()

C++ Interface: client_format_update(DCField self, int do_id, object args)

formatData()

C++ Interface: format_data(const DCField self, bytes 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. Returns empty string if there

  • is an error.

*/

format_data()

C++ Interface: format_data(const DCField self, bytes 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. Returns empty string if there

  • is an error.

*/

getClass()

C++ Interface: get_class(DCField self)

/**

  • Returns the DCClass pointer for the class that contains this field.

*/

getDefaultValue()

C++ Interface: get_default_value(DCField self)

/**

  • Returns the default value for this field. If a default value has been

  • explicitly set (e.g. has_default_value() returns true), returns that

  • value; otherwise, returns an implicit default for the field.

*/

getNumber()

C++ Interface: get_number(DCField self)

/**

  • Returns a unique index number associated with this field. This is defined

  • implicitly when the .dc file(s) are read.

*/

get_class()

C++ Interface: get_class(DCField self)

/**

  • Returns the DCClass pointer for the class that contains this field.

*/

get_default_value()

C++ Interface: get_default_value(DCField self)

/**

  • Returns the default value for this field. If a default value has been

  • explicitly set (e.g. has_default_value() returns true), returns that

  • value; otherwise, returns an implicit default for the field.

*/

get_number()

C++ Interface: get_number(DCField self)

/**

  • Returns a unique index number associated with this field. This is defined

  • implicitly when the .dc file(s) are read.

*/

hasDefaultValue()

C++ Interface: has_default_value(DCField self)

/**

  • Returns true if a default value has been explicitly established for this

  • field, false otherwise.

*/

has_default_value()

C++ Interface: has_default_value(DCField self)

/**

  • Returns true if a default value has been explicitly established for this

  • field, false otherwise.

*/

isAirecv()

C++ Interface: is_airecv(DCField self)

/**

  • Returns true if the “airecv” flag is set for this field, false otherwise.

*/

isBogusField()

C++ Interface: is_bogus_field(DCField self)

/**

  • Returns true if the field has been flagged as a bogus field. This is set

  • for fields that are generated by the parser as placeholder for missing

  • fields, as when reading a partial file; it should not occur in a normal

  • valid dc file.

*/

isBroadcast()

C++ Interface: is_broadcast(DCField self)

/**

  • Returns true if the “broadcast” flag is set for this field, false

  • otherwise.

*/

isClrecv()

C++ Interface: is_clrecv(DCField self)

/**

  • Returns true if the “clrecv” flag is set for this field, false otherwise.

*/

isClsend()

C++ Interface: is_clsend(DCField self)

/**

  • Returns true if the “clsend” flag is set for this field, false otherwise.

*/

isDb()

C++ Interface: is_db(DCField self)

/**

  • Returns true if the “db” flag is set for this field, false otherwise.

*/

isOwnrecv()

C++ Interface: is_ownrecv(DCField self)

/**

  • Returns true if the “ownrecv” flag is set for this field, false otherwise.

*/

isOwnsend()

C++ Interface: is_ownsend(DCField self)

/**

  • Returns true if the “ownsend” flag is set for this field, false otherwise.

*/

isRam()

C++ Interface: is_ram(DCField self)

/**

  • Returns true if the “ram” flag is set for this field, false otherwise.

*/

isRequired()

C++ Interface: is_required(DCField self)

/**

  • Returns true if the “required” flag is set for this field, false otherwise.

*/

is_airecv()

C++ Interface: is_airecv(DCField self)

/**

  • Returns true if the “airecv” flag is set for this field, false otherwise.

*/

is_bogus_field()

C++ Interface: is_bogus_field(DCField self)

/**

  • Returns true if the field has been flagged as a bogus field. This is set

  • for fields that are generated by the parser as placeholder for missing

  • fields, as when reading a partial file; it should not occur in a normal

  • valid dc file.

*/

is_broadcast()

C++ Interface: is_broadcast(DCField self)

/**

  • Returns true if the “broadcast” flag is set for this field, false

  • otherwise.

*/

is_clrecv()

C++ Interface: is_clrecv(DCField self)

/**

  • Returns true if the “clrecv” flag is set for this field, false otherwise.

*/

is_clsend()

C++ Interface: is_clsend(DCField self)

/**

  • Returns true if the “clsend” flag is set for this field, false otherwise.

*/

is_db()

C++ Interface: is_db(DCField self)

/**

  • Returns true if the “db” flag is set for this field, false otherwise.

*/

is_ownrecv()

C++ Interface: is_ownrecv(DCField self)

/**

  • Returns true if the “ownrecv” flag is set for this field, false otherwise.

*/

is_ownsend()

C++ Interface: is_ownsend(DCField self)

/**

  • Returns true if the “ownsend” flag is set for this field, false otherwise.

*/

is_ram()

C++ Interface: is_ram(DCField self)

/**

  • Returns true if the “ram” flag is set for this field, false otherwise.

*/

is_required()

C++ Interface: is_required(DCField self)

/**

  • Returns true if the “required” flag is set for this field, false otherwise.

*/

output()

C++ Interface: output(DCField self, ostream out)

/**

  • Write a string representation of this instance to <out>.

*/

packArgs()

C++ Interface: pack_args(DCField self, DCPacker packer, object sequence)

pack_args()

C++ Interface: pack_args(DCField self, DCPacker packer, object sequence)

parseString()

C++ Interface: parse_string(const DCField self, 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. Returns empty string if there is an error.

*/

parse_string()

C++ Interface: parse_string(const DCField self, 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. Returns empty string if there is an error.

*/

receiveUpdate()

C++ Interface: receive_update(DCField self, DCPacker packer, object distobj)

receive_update()

C++ Interface: receive_update(DCField self, DCPacker packer, object distobj)

unpackArgs()

C++ Interface: unpack_args(DCField self, DCPacker packer)

unpack_args()

C++ Interface: unpack_args(DCField self, DCPacker packer)

upcastToDCKeywordList()

C++ Interface: upcast_to_DCKeywordList(const DCField self)

upcast from DCField to DCKeywordList

upcastToDCPackerInterface()

C++ Interface: upcast_to_DCPackerInterface(const DCField self)

upcast from DCField to DCPackerInterface

upcast_to_DCKeywordList()

C++ Interface: upcast_to_DCKeywordList(const DCField self)

upcast from DCField to DCKeywordList

upcast_to_DCPackerInterface()

C++ Interface: upcast_to_DCPackerInterface(const DCField self)

upcast from DCField to DCPackerInterface

validateRanges()

C++ Interface: validate_ranges(DCField self, bytes 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. Returns true if all fields are valid, false otherwise.

*/

validate_ranges()

C++ Interface: validate_ranges(DCField self, bytes 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. Returns true if all fields are valid, false otherwise.

*/

write()

C++ Interface: write(DCField self, ostream out, int indent_level)

/**

  • Write a string representation of this instance to <out>.

*/