# panda3d.core.PfmVizzer¶

from panda3d.core import PfmVizzer

class PfmVizzer

This class aids in the visualization and manipulation of PfmFile objects.

Inheritance diagram

__init__(pfm: PfmFile) → None

The PfmVizzer constructor receives a reference to a PfmFile which it will operate on. It does not keep ownership of this reference; it is your responsibility to ensure the PfmFile does not destruct during the lifetime of the PfmVizzer.

__init__(param0: PfmVizzer) → None
getPfm() → PfmFile

Returns the reference to the PfmFile manipulated by this PfmVizzer.

Return type

PfmFile

getPfm() → PfmFile

Returns the reference to the PfmFile manipulated by this PfmVizzer.

Return type

PfmFile

project(lens: Lens, undist_lut: PfmFile) → None

Adjusts each (x, y, z) point of the Pfm file by projecting it through the indicated lens, converting each point to a (u, v, w) texture coordinate. The resulting file can be generated to a mesh (with set_vis_inverse(true) and generateVisMesh()) that will apply the lens distortion to an arbitrary texture image.

extrude(lens: Lens) → None

Converts each (u, v, depth) point of the Pfm file to an (x, y, z) point, by reversing project(). If the original file is only a 1-d file, assumes that it is a depth map with implicit (u, v) coordinates.

This method is only valid for a linear lens (e.g. a PerspectiveLens or OrthographicLens). Non-linear lenses don’t necessarily compute a sensible depth coordinate.

setVisInverse(vis_inverse: bool) → None

Sets the vis_inverse flag. When this flag is true, vis meshes and point clouds are generated with the 3-d depth value in the texture coordinates, and the 2-d index value in the vertex position. When it is false, meshes are generated normally, with the 3-d depth value in the vertex position and the 2-d index value in the texture coordinates.

This may be used in lieu of the lower-level addVisColumn().

getVisInverse() → bool

Returns the vis_inverse flag. See setVisInverse().

setFlatTexcoordName(flat_texcoord_name: InternalName) → None

If the flat_texcoord_name is specified, it is the name of an additional vertex column that will be created for the “flat” texture coordinates, i.e. the original 0..1 values that correspond to the 2-D index position of each point in the original pfm file.

These are the same values that will be assigned to the default texture coordinates if the vis_inverse flag is not true.

This may be used in lieu of the lower-level addVisColumn().

clearFlatTexcoordName() → None

Resets the flat_texcoord_name to empty, so that additional texture coordinates are not created.

This may be used in lieu of the lower-level addVisColumn().

getFlatTexcoordName() → InternalName

Returns the flat_texcoord_name. See setFlatTexcoordName().

Return type

InternalName

setVis2d(vis_2d: bool) → None

Sets the vis_2d flag. When this flag is true, only the first two (x, y) value of each depth point is considered meaningful; the z component is ignored. This is only relevant for generating visualizations.

This may be used in lieu of the lower-level addVisColumn().

getVis2d() → bool

Returns the vis_2d flag. See setVis2d().

setKeepBeyondLens(keep_beyond_lens: bool) → None

Sets the keep_beyond_lens flag. When this flag is true, points that fall outside of the normal lens range in project() or in addVisColumn() will be retained anyway; when it is false, these points will be discarded.

getKeepBeyondLens() → bool

Returns the keep_beyond_lens flag. See setKeepBeyondLens().

setVisBlend(vis_blend: PNMImage) → None

Specifies a blending map–a grayscale image–that will be applied to the vertex color during generateVisMesh() and generateVisPoints(). The image size must exactly match the mesh size of the PfmVizzer.

Ownership of the pointer is not kept by the PfmVizzer; it is your responsibility to ensure it does not destruct during the lifetime of the PfmVizzer (or at least not before your subsequent call to generateVisMesh()).

clearVisBlend() → None

Removes the blending map set by a prior call to setVisBlend().

getVisBlend() → PNMImage

Returns the blending map set by the most recent call to setVisBlend(), or NULL if there is no blending map in effect.

Return type

PNMImage

setAuxPfm(pfm: PfmFile) → None

Assigns an auxiliary PfmFile to this PfmVizzer. This file will be queried by column types CT_aux_vertex1/2/3, but has no other meaning to the vizzer. This size of this PfmFile should exactly match the base PfmFile. No reference count is held and no copy is made; the caller is responsible for ensuring that the auxiliary PfmFile will persist throughout the lifetime of the PfmVizzer it is assigned to.

clearAuxPfm() → None

Removes the auxiliary PfmFile from this PfmVizzer.

getAuxPfm() → PfmFile

Returns the reference to the auxiliary PfmFile queried by this PfmVizzer. This contains the values that will be reflected in CT_aux_vertex3 etc. See setAuxPfm().

Return type

PfmFile

clearVisColumns() → None

Removes all of the previously-added vis columns in preparation for building a new list. See addVisColumn().

addVisColumn(source: ColumnType, target: ColumnType, name: InternalName, transform: TransformState, lens: Lens, undist_lut: PfmFile) → None

Adds a new vis column specification to the list of vertex data columns that will be generated at the next call to generateVisPoints() or generateVisMesh(). This advanced interface supercedes the higher-level setVisInverse(), setFlatTexcoordName(), and setVis2d().

If you use this advanced interface, you must specify explicitly the complete list of data columns to be created in the resulting GeomVertexData, by calling addVisColumn() each time. For each column, you specify the source of the column in the PFMFile, the target column and name in the GeomVertexData, and an optional transform matrix and/or lens to transform and project the point before generating it.

generateVisPoints() → NodePath

Creates a point cloud with the points of the pfm as 3-d coordinates in space, and texture coordinates ranging from 0 .. 1 based on the position within the pfm grid.

Return type

NodePath

generateVisMesh(face: MeshFace) → NodePath

Creates a triangle mesh with the points of the pfm as 3-d coordinates in space, and texture coordinates ranging from 0 .. 1 based on the position within the pfm grid.

Return type

NodePath

calcMaxUDisplacement() → float

Computes the maximum amount of shift, in pixels either left or right, of any pixel in the distortion map. This can be passed to makeDisplacement(); see that function for more information.

calcMaxVDisplacement() → float

Computes the maximum amount of shift, in pixels either up or down, of any pixel in the distortion map. This can be passed to makeDisplacement(); see that function for more information.

makeDisplacement(result: PNMImage, max_u: float, max_v: float, for_32bit: bool) → None

Assuming the underlying PfmFile is a 2-d distortion mesh, with the U and V in the first two components and the third component unused, this computes an AfterEffects-style displacement map that represents the same distortion. The indicated PNMImage will be filled in with a displacement map image, with horizontal shift in the red channel and vertical shift in the green channel, where a fully bright (or fully black) pixel indicates a shift of max_u or max_v pixels.

Use calcMaxUDisplacement() and calcMaxVDisplacement() to compute suitable values for max_u and max_v.

This generates an integer 16-bit displacement image. It is a good idea, though not necessarily essential, to check “Preserve RGB” in the interpret footage section for each displacement image. Set for_32bit true if this is meant to be used in a 32-bit project file, and false if it is meant to be used in a 16-bit project file.

makeDisplacement(result: PfmFile, max_u: float, max_v: float, for_32bit: bool) → None

Assuming the underlying PfmFile is a 2-d distortion mesh, with the U and V in the first two components and the third component unused, this computes an AfterEffects-style displacement map that represents the same distortion. The indicated PNMImage will be filled in with a displacement map image, with horizontal shift in the red channel and vertical shift in the green channel, where a fully bright (or fully black) pixel indicates a shift of max_u or max_v pixels.

Use calcMaxUDisplacement() and calcMaxVDisplacement() to compute suitable values for max_u and max_v.

This generates a 32-bit floating-point displacement image. It is essential to check “Preserve RGB” in the interpret footage section for each displacement image. Set for_32bit true if this is meant to be used in a 32-bit project file, and false if it is meant to be used in a 16-bit project file.

enum ColumnType
enumerator CT_texcoord2 = 0
enumerator CT_texcoord3 = 1
enumerator CT_vertex1 = 2
enumerator CT_vertex2 = 3
enumerator CT_vertex3 = 4
enumerator CT_normal3 = 5
enumerator CT_blend1 = 6
enumerator CT_aux_vertex1 = 7
enumerator CT_aux_vertex2 = 8
enumerator CT_aux_vertex3 = 9
enum MeshFace
enumerator MF_front = 1
enumerator MF_back = 2
enumerator MF_both = 3