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

A ProjectionScreen implements a simple system for projective texturing. More...

Inheritance diagram for ProjectionScreen:
PandaNode TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject

Public Member Functions

 __init__ (str name)
 
 clearUndistLut ()
 Removes the distortion lookup table from the projector, if specified. More...
 
GeomNode generateScreen (const NodePath projector, str screen_name, int num_x_verts, int num_y_verts, float distance, float fill_ratio)
 Synthesizes a polygon mesh based on the projection area of the indicated projector. More...
 
bool getAutoRecompute ()
 Returns the auto_recompute flag. More...
 
const LColor getFrameColor ()
 Returns the color the screen will be painted at the portions outside of the lens' frustum. More...
 
bool getInvertUvs ()
 Returns whether this screen is compensating for a graphics driver inverting the framebuffer image. More...
 
const UpdateSeq getLastScreen ()
 Returns an UpdateSeq corresponding to the last time a screen mesh was generated for the ProjectionScreen. More...
 
const NodePath getProjector ()
 Returns the NodePath to the LensNode that is to serve as the projector for this screen, or empty if no projector is associated. More...
 
bool getTexcoord3d ()
 See set_texcoord_3d(). More...
 
str getTexcoordName ()
 Returns the name of the texture coordinates that will be generated by this particular ProjectionScreen, as set by set_texcoord_name(). More...
 
const PfmFile getUndistLut ()
 Returns the distortion lookup table provided via set_undist_lut(), if any. More...
 
const LColor getVignetteColor ()
 Returns the color the screen will be painted at the portions outside of the lens' frustum. More...
 
bool getVignetteOn ()
 Returns true if vertex-based vignetting is on, false otherwise. More...
 
bool hasUndistLut ()
 Returns true if a valid distortion lookup table was provided via set_undist_lut(), false otherwise. More...
 
PandaNode makeFlatMesh (const NodePath this_np, const NodePath camera)
 Generates a deep copy of the hierarchy at the ProjectionScreen node and below, with vertices flattened into two dimensions as if they were seen by the indicated camera node. More...
 
 recompute ()
 Recomputes all the UV's for geometry below the ProjectionScreen node, as if the texture were projected from the associated projector. More...
 
bool recomputeIfStale ()
 Calls recompute() only if the relative transform between the ProjectionScreen and the projector has changed, or if any other relevant property has changed. More...
 
bool recomputeIfStale (const NodePath this_np)
 Calls recompute() only if the relative transform between the ProjectionScreen and the projector has changed, or if any other relevant property has changed. More...
 
 regenerateScreen (const NodePath projector, str screen_name, int num_x_verts, int num_y_verts, float distance, float fill_ratio)
 Removes all the children from the ProjectionScreen node, and adds the newly generated child returned by generate_screen(). More...
 
 setAutoRecompute (bool auto_recompute)
 Sets the auto_recompute flag. More...
 
 setFrameColor (const LColor frame_color)
 Specifies the color the screen will be painted at the portions outside of the lens' frustum; i.e. More...
 
 setInvertUvs (bool invert_uvs)
 Some OpenGL graphics drivers are known to invert the framebuffer image when they copy it to texture. More...
 
 setProjector (const NodePath projector)
 Specifies the LensNode that is to serve as the projector for this screen. More...
 
 setTexcoord3d (bool texcoord_3d)
 Set this true to force 3-D texture coordinates to be created for the geometry. More...
 
 setTexcoordName (str texcoord_name)
 Specifies the name of the texture coordinates that are generated by this particular ProjectionScreen. More...
 
 setUndistLut (const PfmFile undist_lut)
 Applies a distortion lookup table to the projector. More...
 
 setVignetteColor (const LColor vignette_color)
 Specifies the color the screen will be painted at the portions outside of the lens' frustum; i.e. More...
 
 setVignetteOn (bool vignette_on)
 Specifies whether vertex-based vignetting should be on. More...
 
- Public Member Functions inherited from PandaNode
PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
int __traverse__ (Visitproc visit, void arg)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node, directly as a stashed child. More...
 
 adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
Light asLight ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
 clearAttrib (TypeHandle type)
 Removes the render attribute of the given type from this node. More...
 
 clearAttrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
 clearBounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
 clearEffect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
 clearEffects (Thread current_thread)
 Resets this node to have no render effects. More...
 
 clearPythonTag (object key)
 
 clearState (Thread current_thread)
 Resets this node to leave the render state alone. More...
 
 clearTag (str key, Thread current_thread)
 Removes the value defined for this key on this particular node. More...
 
 clearTransform (Thread current_thread)
 Resets the transform on this node to the identity transform. More...
 
 clearUnexpectedChange (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
PandaNode combineWith (PandaNode other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compareTags (const PandaNode other)
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
 copyAllProperties (PandaNode other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
 copyChildren (PandaNode other, Thread current_thread)
 Makes another instance of all the children of the other node, copying them to this node. More...
 
PandaNode copySubgraph (Thread current_thread)
 Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. More...
 
 copyTags (PandaNode other)
 Copies all of the tags stored on the other node onto this node. More...
 
int countNumDescendants ()
 Returns the number of nodes at and below this level. More...
 
int findChild (PandaNode node, Thread current_thread)
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int findParent (PandaNode node, Thread current_thread)
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int findStashed (PandaNode node, Thread current_thread)
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
const RenderAttrib getAttrib (TypeHandle type)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderAttrib getAttrib (int slot)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const BoundingVolume getBounds (Thread current_thread)
 Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes. More...
 
const BoundingVolume getBounds (UpdateSeq seq, Thread current_thread)
 This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. More...
 
BoundingVolume::BoundsType getBoundsType ()
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode getChild (int n, Thread current_thread)
 Returns the nth child node of this node. More...
 
list getChildren ()
 
int getChildSort (int n, Thread current_thread)
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. More...
 
const RenderEffect getEffect (TypeHandle type)
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderEffects getEffects (Thread current_thread)
 Returns the complete RenderEffects that will be applied to this node. More...
 
int getFancyBits (Thread current_thread)
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 Returns the node's internal bounding volume. More...
 
int getInternalVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask getIntoCollideMask ()
 Returns the "into" collide mask for this node. More...
 
CollideMask getLegalCollideMask ()
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int getNestedVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask getNetCollideMask (Thread current_thread)
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask getNetDrawControlMask ()
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask getNetDrawShowMask ()
 Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below. More...
 
int getNumChildren (Thread current_thread)
 Returns the number of child nodes this node has. More...
 
int getNumParents (Thread current_thread)
 Returns the number of parent nodes this node has. More...
 
int getNumStashed (Thread current_thread)
 Returns the number of stashed nodes this node has. More...
 
const RenderAttrib getOffClipPlanes (Thread current_thread)
 Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More...
 
PandaNode getParent (int n, Thread current_thread)
 Returns the nth parent node of this node. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. More...
 
object getPythonTag (object key)
 
object getPythonTagKeys ()
 
object getPythonTags ()
 
PandaNode::Stashed getStashed (Thread current_thread)
 Returns an object that can be used to walk through the list of children of the node. More...
 
PandaNode getStashed (int n, Thread current_thread)
 Returns the nth stashed child of this node. More...
 
list getStashed ()
 
int getStashedSort (int n, Thread current_thread)
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
const RenderState getState (Thread current_thread)
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
str getTag (str key, Thread current_thread)
 Retrieves the user-defined value that was previously set on this node for the particular key, if any. More...
 
object getTagKeys ()
 
const TransformState getTransform (Thread current_thread)
 Returns the transform that has been set on this particular node. More...
 
unsigned int getUnexpectedChange (unsigned int flags)
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
bool hasAttrib (TypeHandle type)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasAttrib (int slot)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasDirtyPrevTransform ()
 Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). More...
 
bool hasEffect (TypeHandle type)
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
bool hasPythonTag (object key)
 
bool hasTag (str key, Thread current_thread)
 Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More...
 
bool hasTags ()
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
bool isAmbientLight ()
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool isBoundsStale ()
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
bool isCollisionNode ()
 A simple downcast check. More...
 
bool isFinal (Thread current_thread)
 Returns the current state of the "final" flag. More...
 
bool isGeomNode ()
 A simple downcast check. More...
 
bool isLodNode ()
 A simple downcast check. More...
 
bool isOverallHidden ()
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool isSceneRoot ()
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool isUnderSceneRoot ()
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
 listTags (Ostream out, str separator)
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
 ls (Ostream out, int indent_level)
 Lists all the nodes at and below the current path hierarchically. More...
 
PandaNode makeCopy ()
 Returns a newly-allocated PandaNode that is a shallow copy of this one. More...
 
 markBoundsStale (Thread current_thread)
 Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More...
 
 markInternalBoundsStale (Thread current_thread)
 Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More...
 
 output (Ostream out)
 
 prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. More...
 
 removeAllChildren (Thread current_thread)
 Removes all the children from the node at once, including stashed children. More...
 
bool removeChild (PandaNode child_node, Thread current_thread)
 Removes the indicated child from the node. More...
 
 removeChild (int child_index, Thread current_thread)
 Removes the nth child from the node. More...
 
 removeStashed (int child_index, Thread current_thread)
 Removes the nth stashed child from the node. More...
 
bool replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread)
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
 replaceNode (PandaNode other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
 resetPrevTransform (Thread current_thread)
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 Adds the indicated render attribute to the scene graph on this node. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. More...
 
 setBounds (const BoundingVolume volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
 setEffect (const RenderEffect effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 Sets the complete RenderEffects that will be applied this node. More...
 
 setFinal (bool flag)
 Sets the "final" flag on this PandaNode. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
 setPrevTransform (const TransformState transform, Thread current_thread)
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
 setPythonTag (object key, object value)
 
 setState (const RenderState state, Thread current_thread)
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
 setTag (str key, str value, Thread current_thread)
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 Sets the transform that will be applied to this node and below. More...
 
 setUnexpectedChange (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stashChild (PandaNode child_node, Thread current_thread)
 Stashes the indicated child node. More...
 
 stashChild (int child_index, Thread current_thread)
 Stashes the indicated child node. More...
 
 stealChildren (PandaNode other, Thread current_thread)
 Moves all the children from the other node onto this node. More...
 
bool unstashChild (PandaNode child_node, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 write (Ostream out, int indent_level)
 
- 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...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from PandaNode
static PandaNode 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 DrawMask getAllCameraMask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle getClassType ()
 
static DrawMask getOverallBit ()
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
static resetAllPrevTransform (Thread current_thread)
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. 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 ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 1, FB_state = 2, FB_effects = 4, FB_tag = 16,
  FB_draw_mask = 32, FB_cull_callback = 64
}
 
enum  UnexpectedChange {
  UC_parents = 1, UC_children = 2, UC_transform = 4, UC_state = 8,
  UC_draw_mask = 16
}
 
- Public Attributes inherited from PandaNode
DrawMask all_camera_mask
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
bool bounds_stale
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
BoundingVolume::BoundsType bounds_type
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode::Children children
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask draw_control_mask
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask draw_show_mask
 Returns the hide/show bits of this particular node. More...
 
ConstPointerToRenderEffects effects
 Returns the complete RenderEffects that will be applied to this node. More...
 
bool final
 Returns the current state of the "final" flag. More...
 
ConstPointerToBoundingVolume internal_bounds
 Returns the node's internal bounding volume. More...
 
int internal_vertices
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask into_collide_mask
 Returns the "into" collide mask for this node. More...
 
CollideMask legal_collide_mask
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int nested_vertices
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
DrawMask overall_bit
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
bool overall_hidden
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
PandaNode::Parents parents
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
ConstPointerToTransformState prev_transform
 Returns the transform that has been set as this node's "previous" position. More...
 
object python_tags
 
PandaNode::Stashed stashed
 Returns the nth stashed child of this node. More...
 
ConstPointerToRenderState state
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
String tags []
 
ConstPointerToTransformState transform
 Returns the transform that has been set on this particular node. 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...
 
- Public Attributes inherited from Namable
const String name
 

Detailed Description

A ProjectionScreen implements a simple system for projective texturing.

The ProjectionScreen node is the parent of a hierarchy of geometry that is considered a "screen"; the ProjectionScreen will automatically recompute all the UV's (for a particular texture stage) on its subordinate geometry according to the relative position and lens parameters of the indicated LensNode.

All this does is recompute UV's; the caller is responsible for applying the appropriate texture(s) to the geometry.

This does not take advantage of any hardware-assisted projective texturing; all of the UV's are computed in the CPU. (Use NodePath::project_texture() to enable hardware-assisted projective texturing.) However, the ProjectionScreen interface does support any kind of lens, linear or nonlinear, that might be defined using the Lens interface, including fisheye and cylindrical lenses.

Member Function Documentation

◆ __init__()

__init__ ( str  name)

◆ clearUndistLut()

clearUndistLut ( )

Removes the distortion lookup table from the projector, if specified.

◆ generateScreen()

GeomNode generateScreen ( const NodePath  projector,
str  screen_name,
int  num_x_verts,
int  num_y_verts,
float  distance,
float  fill_ratio 
)

Synthesizes a polygon mesh based on the projection area of the indicated projector.

This generates and returns a new GeomNode but does not automatically parent it to the ProjectionScreen node; see regenerate_screen().

The specified projector need not be the same as the projector given to the ProjectionScreen with set_projector() (although this is often what you want).

num_x_verts and num_y_verts specify the number of vertices to make in the grid across the horizontal and vertical dimension of the projector, respectively; distance represents the approximate distance of the screen from the lens center.

The fill_ratio parameter specifies the fraction of the image to cover. If it is 1.0, the entire image is shown full-size; if it is 0.9, 10% of the image around the edges is not part of the grid (and the grid is drawn smaller by the same 10%). This is intended to work around graphics drivers that tend to show dark edges or other unsatisfactory artifacts around the edges of textures: render the texture larger than necessary by a certain fraction, and make the screen smaller by the inverse fraction.

◆ getAutoRecompute()

bool getAutoRecompute ( )

Returns the auto_recompute flag.

When this is true, the ProjectionScreen will always be recomputed if necessary before the frame is drawn; when it is false, an explicit call to recompute_if_stale() may be required.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getFrameColor()

const LColor getFrameColor ( )

Returns the color the screen will be painted at the portions outside of the lens' frustum.

See set_frame_color().

◆ getInvertUvs()

bool getInvertUvs ( )

Returns whether this screen is compensating for a graphics driver inverting the framebuffer image.

See set_invert_uvs().

◆ getLastScreen()

const UpdateSeq getLastScreen ( )

Returns an UpdateSeq corresponding to the last time a screen mesh was generated for the ProjectionScreen.

Each time generate_screen() is called, this number is incremented; this allows other objects (like NonlinearImager) to know when they need to recompute themselves.

◆ getProjector()

const NodePath getProjector ( )

Returns the NodePath to the LensNode that is to serve as the projector for this screen, or empty if no projector is associated.

◆ getTexcoord3d()

bool getTexcoord3d ( )

See set_texcoord_3d().

◆ getTexcoordName()

str getTexcoordName ( )

Returns the name of the texture coordinates that will be generated by this particular ProjectionScreen, as set by set_texcoord_name().

◆ getUndistLut()

const PfmFile getUndistLut ( )

Returns the distortion lookup table provided via set_undist_lut(), if any.

◆ getVignetteColor()

const LColor getVignetteColor ( )

Returns the color the screen will be painted at the portions outside of the lens' frustum.

See set_vignette_color().

◆ getVignetteOn()

bool getVignetteOn ( )

Returns true if vertex-based vignetting is on, false otherwise.

See set_vignette_on().

◆ hasUndistLut()

bool hasUndistLut ( )

Returns true if a valid distortion lookup table was provided via set_undist_lut(), false otherwise.

◆ makeFlatMesh()

PandaNode makeFlatMesh ( const NodePath  this_np,
const NodePath  camera 
)

Generates a deep copy of the hierarchy at the ProjectionScreen node and below, with vertices flattened into two dimensions as if they were seen by the indicated camera node.

This is useful for rendering an image as seen through a non-linear lens. The resulting mesh will have vertices in the range [-1, 1] in both x and y, and may be then rendered with an ordinary orthographic lens, to generate the effect of seeing the image through the specified non-linear lens.

The returned node has no parent; it is up to the caller to parent it somewhere or store it so that it does not get dereferenced and deleted.

◆ recompute()

recompute ( )

Recomputes all the UV's for geometry below the ProjectionScreen node, as if the texture were projected from the associated projector.

This function is normally called automatically whenever the relevant properties change, so it should not normally need to be called directly by the user. However, it does no harm to call this if there is any doubt.

◆ recomputeIfStale() [1/2]

bool recomputeIfStale ( )

Calls recompute() only if the relative transform between the ProjectionScreen and the projector has changed, or if any other relevant property has changed.

Returns true if recomputed, false otherwise.

◆ recomputeIfStale() [2/2]

bool recomputeIfStale ( const NodePath  this_np)

Calls recompute() only if the relative transform between the ProjectionScreen and the projector has changed, or if any other relevant property has changed.

Returns true if recomputed, false otherwise.

◆ regenerateScreen()

regenerateScreen ( const NodePath  projector,
str  screen_name,
int  num_x_verts,
int  num_y_verts,
float  distance,
float  fill_ratio 
)

Removes all the children from the ProjectionScreen node, and adds the newly generated child returned by generate_screen().

◆ setAutoRecompute()

setAutoRecompute ( bool  auto_recompute)

Sets the auto_recompute flag.

When this is true, the ProjectionScreen will always be recomputed if necessary before the frame is drawn; when it is false, an explicit call to recompute_if_stale() may be required.

◆ setFrameColor()

setFrameColor ( const LColor  frame_color)

Specifies the color the screen will be painted at the portions outside of the lens' frustum; i.e.

where the lens can't see it or illuminate it. This color is only used if the vignette_on flag is true; see set_vignette_on().

◆ setInvertUvs()

setInvertUvs ( bool  invert_uvs)

Some OpenGL graphics drivers are known to invert the framebuffer image when they copy it to texture.

(This is arguably a problem with the OpenGL spec, which seems to be unclear about the proper ordering of pixels in this operation.)

In any case, set this true to compensate for this effect by inverting the UV's of the projection screen. The default is taken from the Configrc variable project-invert-uvs.

◆ setProjector()

setProjector ( const NodePath  projector)

Specifies the LensNode that is to serve as the projector for this screen.

The relative position of the LensNode to the ProjectionScreen, as well as the properties of the lens associated with the LensNode, determines the UV's that will be assigned to the geometry within the ProjectionScreen.

The NodePath must refer to a LensNode (or a Camera).

◆ setTexcoord3d()

setTexcoord3d ( bool  texcoord_3d)

Set this true to force 3-D texture coordinates to be created for the geometry.

When this is true and the geometry has only 2-D texture coordinates, those texture coordinates are dumped in favor of 3-D coordinates. When this is false, whatever texture coordinates already exist are preserved as-is.

◆ setTexcoordName()

setTexcoordName ( str  texcoord_name)

Specifies the name of the texture coordinates that are generated by this particular ProjectionScreen.

This can be used in the presence of multitexturing to compute the UV's for just a subset of all of the active stages of the multitexture pipeline.

◆ setUndistLut()

setUndistLut ( const PfmFile  undist_lut)

Applies a distortion lookup table to the projector.

This mapping warps the lens effect by passing each ray through an indirection table: the point (u,v) in the indicated lookup table stores the actual (u,v) that the lens produces.

This does not affect the operation of generate_screen().

◆ setVignetteColor()

setVignetteColor ( const LColor  vignette_color)

Specifies the color the screen will be painted at the portions outside of the lens' frustum; i.e.

where the lens can't see it or illuminate it. This color is only used if the vignette_on flag is true; see set_vignette_on().

◆ setVignetteOn()

setVignetteOn ( bool  vignette_on)

Specifies whether vertex-based vignetting should be on.

When this is enabled, vertex color will be set on the screen vertices to color the screen two distinct colors, usually white and black, for the parts of the screen in front of and outside the lens' frustum, respectively. When this is not enabled, the screen color will be left alone.

This effect generally looks terrible, but it does at least make the boundaries of the lens clear.