Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
InternalName Class Reference

Encodes a string name in a hash table, mapping it to a pointer. More...

Inheritance diagram for InternalName:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

InternalName append (str basename)
 Constructs a new InternalName based on this name, with the indicated string following it. More...
 
int findAncestor (str basename)
 Returns the index of the ancestor with the indicated basename, or -1 if no ancestor has that basename. More...
 
const InternalName getAncestor (int n)
 Returns the ancestor with the indicated index number. More...
 
str getBasename ()
 Return the name represented by just this particular InternalName object, ignoring its parents names. More...
 
str getName ()
 Returns the complete name represented by the InternalName and all of its parents. More...
 
str getNetBasename (int n)
 Returns the basename of this name prefixed by the indicated number of ancestors. More...
 
InternalName getParent ()
 Return the parent of this InternalName. More...
 
const InternalName getTop ()
 Returns the oldest ancestor in the InternalName's chain, not counting the root. More...
 
str join (str sep)
 Like get_name, but uses a custom separator instead of ".". More...
 
 output (Ostream out)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static InternalName getAspectRatio ()
 Returns the standard InternalName "aspect_ratio". More...
 
static InternalName getBinormal ()
 Returns the standard InternalName "binormal". More...
 
static InternalName getBinormalName (str name)
 Returns the InternalName "binormal.name", where name is the supplied string. More...
 
static InternalName getCamera ()
 Returns the standard InternalName "camera". More...
 
static TypeHandle getClassType ()
 
static InternalName getColor ()
 Returns the standard InternalName "color". More...
 
static InternalName getError ()
 Returns the standard InternalName "error". More...
 
static InternalName getIndex ()
 Returns the standard InternalName "index". More...
 
static InternalName getModel ()
 Returns the standard InternalName "model". More...
 
static InternalName getMorph (InternalName column, str slider)
 Returns an InternalName derived from the given base column name and the given slider name, which is the column header for the offset vector that should be applied to the base column name when the named morph slider is engaged. More...
 
static InternalName getNormal ()
 Returns the standard InternalName "normal". More...
 
static InternalName getRoot ()
 Returns the standard root InternalName. More...
 
static InternalName getRotate ()
 Returns the standard InternalName "rotate". More...
 
static InternalName getSize ()
 Returns the standard InternalName "size". More...
 
static InternalName getTangent ()
 Returns the standard InternalName "tangent". More...
 
static InternalName getTangentName (str name)
 Returns the InternalName "tangent.name", where name is the supplied string. More...
 
static InternalName getTexcoord ()
 Returns the standard InternalName "texcoord". More...
 
static InternalName getTexcoordName (str name)
 Returns the InternalName "texcoord.name", where name is the supplied string. More...
 
static InternalName getTransformBlend ()
 Returns the standard InternalName "transform_blend". More...
 
static InternalName getTransformIndex ()
 Returns the standard InternalName "transform_index". More...
 
static InternalName getTransformWeight ()
 Returns the standard InternalName "transform_weight". More...
 
static InternalName getVertex ()
 Returns the standard InternalName "vertex". More...
 
static InternalName getView ()
 Returns the standard InternalName "view". More...
 
static InternalName getWorld ()
 Returns the standard InternalName "world". More...
 
static InternalName make (object str)
 
static InternalName make (str name, int index)
 Make using a string and an integer. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

const String basename
 Return the name represented by just this particular InternalName object, ignoring its parents names. More...
 
String name
 Returns the complete name represented by the InternalName and all of its parents. More...
 
InternalName parent
 Return the parent of this InternalName. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

Encodes a string name in a hash table, mapping it to a pointer.

This is used to tokenify names so they may be used efficiently in low-level Panda structures, for instance to differentiate the multiple sets of texture coordinates that might be stored on a Geom.

InternalNames are hierarchical, with the '.' used by convention as a separator character. You can construct a single InternalName as a composition of one or more other names, or by giving it a source string directly.

Member Function Documentation

◆ append()

InternalName append ( str  basename)

Constructs a new InternalName based on this name, with the indicated string following it.

This is a cheaper way to construct a hierarchical name than InternalName::make(parent->get_name() + ".basename").

◆ findAncestor()

int findAncestor ( str  basename)

Returns the index of the ancestor with the indicated basename, or -1 if no ancestor has that basename.

Returns 0 if this name has the basename.

This index value may be passed to get_ancestor() or get_net_basename() to retrieve more information about the indicated name.

◆ getAncestor()

const InternalName getAncestor ( int  n)

Returns the ancestor with the indicated index number.

0 is this name itself, 1 is the name's parent, 2 is the parent's parent, and so on. If there are not enough ancestors, returns the root InternalName.

◆ getAspectRatio()

static InternalName getAspectRatio ( )
static

Returns the standard InternalName "aspect_ratio".

This is the column header for the floating-point aspect ratio value, which is used to define non- square points. This number is the ratio x / y, where y is the point size (above).

◆ getBasename()

str getBasename ( )

Return the name represented by just this particular InternalName object, ignoring its parents names.

This is everything after the rightmost dot.

◆ getBinormal()

static InternalName getBinormal ( )
static

Returns the standard InternalName "binormal".

This is the column header for the tangent vector associated with each vertex, which is a unit vector usually perpendicular to both the normal and the tangent, and in the direction of the V texture coordinate change. It is used for deriving bump maps.

◆ getBinormalName()

static InternalName getBinormalName ( str  name)
static

Returns the InternalName "binormal.name", where name is the supplied string.

This is the column header for the binormal associated with the named texture coordinate set.

◆ getCamera()

static InternalName getCamera ( )
static

Returns the standard InternalName "camera".

This is used as a keyword in the shader subsystem.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getColor()

static InternalName getColor ( )
static

Returns the standard InternalName "color".

This is the column header for the 4-component color value for each vertex.

◆ getError()

static InternalName getError ( )
static

Returns the standard InternalName "error".

◆ getIndex()

static InternalName getIndex ( )
static

Returns the standard InternalName "index".

This is the column header for the integer vertex index. It is not used in the vertex data itself, but is used in the GeomPrimitive structure to index into the vertex data.

◆ getModel()

static InternalName getModel ( )
static

Returns the standard InternalName "model".

This is used as a keyword in the shader subsystem.

◆ getMorph()

static InternalName getMorph ( InternalName  column,
str  slider 
)
static

Returns an InternalName derived from the given base column name and the given slider name, which is the column header for the offset vector that should be applied to the base column name when the named morph slider is engaged.

Each morph slider requires a set of n morph columns, one for each base column it applies to.

◆ getName()

str getName ( )

Returns the complete name represented by the InternalName and all of its parents.

◆ getNetBasename()

str getNetBasename ( int  n)

Returns the basename of this name prefixed by the indicated number of ancestors.

0 is this name's basename, 1 is parent.basename, 2 is grandparent.parent.basename, and so on.

◆ getNormal()

static InternalName getNormal ( )
static

Returns the standard InternalName "normal".

This is the column header for the 3-d lighting normal for each vertex.

◆ getParent()

InternalName getParent ( )

Return the parent of this InternalName.

All names have a parent, except the root name.

◆ getRoot()

static InternalName getRoot ( )
static

Returns the standard root InternalName.

This is the root of all other InternalNames. It has no name itself, and it is the only InternalName with no parent.

◆ getRotate()

static InternalName getRotate ( )
static

Returns the standard InternalName "rotate".

This is the column header for the floating-point rotate value, which represents a number of degrees counter-clockwise to rotate each point or point sprite.

◆ getSize()

static InternalName getSize ( )
static

Returns the standard InternalName "size".

This is the column header for the floating-point size value, which overrides the thickness parameter of the RenderModeAttrib on a per-vertex (e.g. per-point) basis.

◆ getTangent()

static InternalName getTangent ( )
static

Returns the standard InternalName "tangent".

This is the column header for the tangent vector associated with each vertex, which is a unit vector usually perpendicular to the normal and in the direction of the U texture coordinate change. It is used for deriving bump maps.

◆ getTangentName()

static InternalName getTangentName ( str  name)
static

Returns the InternalName "tangent.name", where name is the supplied string.

This is the column header for the tangent associated with the named texture coordinate set.

◆ getTexcoord()

static InternalName getTexcoord ( )
static

Returns the standard InternalName "texcoord".

This is the column header for the default texture coordinate set for each vertex. It is also used for identifying the default texture coordinate set in a TextureStage.

◆ getTexcoordName()

static InternalName getTexcoordName ( str  name)
static

Returns the InternalName "texcoord.name", where name is the supplied string.

This is the column header for the named texture coordinate set for each vertex. It is also used for identifying the named texture coordinate set in a TextureStage.

◆ getTop()

const InternalName getTop ( )

Returns the oldest ancestor in the InternalName's chain, not counting the root.

This will be the first name in the string, e.g. "texcoord.foo.bar" will return the InternalName "texcoord".

◆ getTransformBlend()

static InternalName getTransformBlend ( )
static

Returns the standard InternalName "transform_blend".

This is the column header for the integer transform_blend index, which is used to define vertex animation on the CPU by indexing to a particular vertex weighting from the TransformBlendTable.

◆ getTransformIndex()

static InternalName getTransformIndex ( )
static

Returns the standard InternalName "transform_index".

This is the column header for the n-component transform_index value, which is used in conjuntion with "transform_weight" to define vertex animation on the graphics card. The transform_index value specifies the nth transform, by lookup in the TransformTable. The transform_index column may be omitted, in which case the nth transform is the nth entry in the table.

◆ getTransformWeight()

static InternalName getTransformWeight ( )
static

Returns the standard InternalName "transform_weight".

This is the column header for the n-component transform_weight value, which is used in conjuntion with "transform_index" to define vertex animation on the graphics card. The transform_weight value specifies the weight of the nth transform. By convention, there are 1 fewer weight values than transforms, since the weights are assumed to sum to 1 (and the last value is therefore implicit).

◆ getVertex()

static InternalName getVertex ( )
static

Returns the standard InternalName "vertex".

This is the column header for the 3-d or 4-d vertex position information for each vertex.

◆ getView()

static InternalName getView ( )
static

Returns the standard InternalName "view".

This is used as a keyword in the shader subsystem.

◆ getWorld()

static InternalName getWorld ( )
static

Returns the standard InternalName "world".

This is used as a keyword in the shader subsystem.

◆ join()

str join ( str  sep)

Like get_name, but uses a custom separator instead of ".".

◆ make() [1/2]

static InternalName make ( object  str)
static

◆ make() [2/2]

static InternalName make ( str  name,
int  index 
)
static

Make using a string and an integer.

Concatenates the two.

◆ output()

output ( Ostream  out)

Member Data Documentation

◆ basename

const String basename

Return the name represented by just this particular InternalName object, ignoring its parents names.

This is everything after the rightmost dot.

◆ name

String name

Returns the complete name represented by the InternalName and all of its parents.

◆ parent

InternalName parent

Return the parent of this InternalName.

All names have a parent, except the root name.