|
|
|
A base class for any number of different kinds of lenses, linear and otherwise.
More...
#include "lens.h"
List of all members.
Classes |
| class | CData |
Public Types |
| enum | FromCorners {
FC_roll = 0x0001,
FC_camera_plane = 0x0002,
FC_off_axis = 0x0004,
FC_aspect_ratio = 0x0008,
FC_shear = 0x0010,
FC_keystone = 0x0020
} |
| enum | StereoChannel { SC_mono = 0x00,
SC_left = 0x01,
SC_right = 0x02,
SC_stereo = 0x03
} |
Public Member Functions |
|
| Lens (const Lens ©) |
| void | clear () |
| | Resets all lens parameters to their initial default settings.
|
| void | clear_custom_film_mat () |
| | Disables the lens custom_film_mat correction.
|
| void | clear_keystone () |
| | Disables the lens keystone correction.
|
| void | clear_view_mat () |
| | Resets the lens transform to identity.
|
| bool | extrude (const LPoint2 &point2d, LPoint3 &near_point, LPoint3 &far_point) const |
| | Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the corresponding vector in space that maps to this point, if such a vector can be determined.
|
| bool | extrude (const LPoint3 &point2d, LPoint3 &near_point, LPoint3 &far_point) const |
| | Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the corresponding vector in space that maps to this point, if such a vector can be determined.
|
| bool | extrude_depth (const LPoint3 &point2d, LPoint3 &point3d) const |
| | Uses the depth component of the 3-d result from project() to compute the original point in 3-d space corresponding to a particular point on the lens.
|
| bool | extrude_vec (const LPoint2 &point2d, LVector3 &vec3d) const |
| | Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the vector that corresponds to the view direction.
|
| bool | extrude_vec (const LPoint3 &point2d, LVector3 &vec3d) const |
| | Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the vector that corresponds to the view direction.
|
|
virtual TypeHandle | force_init_type () |
| PN_stdfloat | get_aspect_ratio () const |
| | Returns the aspect ratio of the Lens.
|
| const string & | get_change_event () const |
| | Returns the name of the event that will be generated whenever any properties of this particular Lens have changed.
|
| PN_stdfloat | get_convergence_distance () const |
| | See set_convergence_distance().
|
| CoordinateSystem | get_coordinate_system () const |
| | Returns the coordinate system that all 3-d computations are performed within for this Lens.
|
| const LMatrix4 & | get_custom_film_mat () const |
| | Returns the custom_film_mat specified for the lens.
|
| PN_stdfloat | get_far () const |
| | Returns the position of the far plane (or cylinder, sphere, whatever).
|
| const LMatrix4 & | get_film_mat () const |
| | Returns the matrix that transforms from a point behind the lens to a point on the film.
|
| const LMatrix4 & | get_film_mat_inv () const |
| | Returns the matrix that transforms from a point on the film to a point behind the lens.
|
| const LVector2 & | get_film_offset () const |
| | Returns the horizontal and vertical offset amounts of this Lens.
|
| const LVecBase2 & | get_film_size () const |
| | Returns the horizontal and vertical film size of the virtual film.
|
| PN_stdfloat | get_focal_length () const |
| | Returns the focal length of the lens.
|
| const LVecBase2 & | get_fov () const |
| | Returns the horizontal and vertical film size of the virtual film.
|
| PN_stdfloat | get_hfov () const |
| | Returns the horizontal component of fov only.
|
| PN_stdfloat | get_interocular_distance () const |
| | See set_interocular_distance().
|
| const LVecBase2 & | get_keystone () const |
| | Returns the keystone correction specified for the lens.
|
| UpdateSeq | get_last_change () const |
| | Returns the UpdateSeq that is incremented whenever the lens properties are changed.
|
| const LMatrix4 & | get_lens_mat () const |
| | Returns the matrix that transforms from a point in front of the lens to a point in space.
|
| const LMatrix4 & | get_lens_mat_inv () const |
| | Returns the matrix that transforms from a point in space to a point in front of the lens.
|
| PN_stdfloat | get_min_fov () const |
| | Returns the field of view of the narrowest dimension of the window.
|
| PN_stdfloat | get_near () const |
| | Returns the position of the near plane (or cylinder, sphere, whatever).
|
| LPoint3 | get_nodal_point () const |
| | Returns the center point of the lens: the point from which the lens is viewing.
|
| const LMatrix4 & | get_projection_mat (StereoChannel channel=SC_mono) const |
| | Returns the complete transformation matrix from a 3-d point in space to a point on the film, if such a matrix exists, or the identity matrix if the lens is nonlinear.
|
| const LMatrix4 & | get_projection_mat_inv (StereoChannel channel=SC_mono) const |
| | Returns the matrix that transforms from a 2-d point on the film to a 3-d vector in space, if such a matrix exists.
|
|
virtual TypeHandle | get_type () const |
| const LVector3 & | get_up_vector () const |
| | Returns the axis perpendicular to the camera's view vector that indicates the "up" direction.
|
| PN_stdfloat | get_vfov () const |
| | Returns the vertical component of fov only.
|
| const LVecBase3 & | get_view_hpr () const |
| | Returns the direction in which the lens is facing.
|
| const LMatrix4 & | get_view_mat () const |
| | Returns the direction in which the lens is facing.
|
| const LVector3 & | get_view_vector () const |
| | Returns the axis along which the lens is facing.
|
| virtual bool | is_linear () const |
| | Returns true if the lens represents a linear projection (e.g.
|
| virtual bool | is_orthographic () const |
| | Returns true if the lens represents a orthographic projection (i.e.
|
| virtual bool | is_perspective () const |
| | Returns true if the lens represents a perspective projection (i.e.
|
|
void | operator= (const Lens ©) |
|
virtual void | output (ostream &out) const |
| bool | project (const LPoint3 &point3d, LPoint3 &point2d) const |
| | Given a 3-d point in space, determine the 2-d point this maps to, in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner.
|
| bool | project (const LPoint3 &point3d, LPoint2 &point2d) const |
| | Given a 3-d point in space, determine the 2-d point this maps to, in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner.
|
|
virtual | PT (Lens) make_copy() const =0 |
|
virtual | PT (Geom) make_geometry() |
|
virtual | PT (BoundingVolume) make_bounds() const |
| void | recompute_all () |
| | Forces all internal parameters of the Lens to be recomputed.
|
| void | set_aspect_ratio (PN_stdfloat aspect_ratio) |
| | Sets the aspect ratio of the lens.
|
| void | set_change_event (const string &event) |
| | Sets the name of the event that will be generated whenever any properties of the Lens have changed.
|
| void | set_convergence_distance (PN_stdfloat convergence_distance) |
| | Sets the distance between between the camera plane and the point in the distance that the left and right eyes are both looking at.
|
| void | set_coordinate_system (CoordinateSystem cs) |
| | Specifies the coordinate system that all 3-d computations are performed within for this Lens.
|
| void | set_custom_film_mat (const LMatrix4 &custom_film_mat) |
| | Specifies a custom matrix to transform the points on the film after they have been converted into nominal film space (-1 .
|
| void | set_far (PN_stdfloat far_distance) |
| | Defines the position of the far plane (or cylinder, sphere, whatever).
|
| void | set_film_offset (PN_stdfloat x, PN_stdfloat y) |
| | Sets the horizontal and vertical offset amounts of this Lens.
|
| void | set_film_offset (const LVecBase2 &film_offset) |
| | Sets the horizontal and vertical offset amounts of this Lens.
|
| void | set_film_size (PN_stdfloat width) |
| | Sets the horizontal size of the film without changing its shape.
|
| void | set_film_size (PN_stdfloat width, PN_stdfloat height) |
| | Sets the size and shape of the "film" within the lens.
|
| void | set_film_size (const LVecBase2 &film_size) |
| | Sets the size and shape of the "film" within the lens.
|
| void | set_focal_length (PN_stdfloat focal_length) |
| | Sets the focal length of the lens.
|
| void | set_fov (PN_stdfloat fov) |
| | Sets the horizontal field of view of the lens without changing the aspect ratio.
|
| void | set_fov (PN_stdfloat hfov, PN_stdfloat vfov) |
| | Sets the field of view of the lens in both dimensions.
|
| void | set_fov (const LVecBase2 &fov) |
| | Sets the field of view of the lens in both dimensions.
|
| void | set_frustum_from_corners (const LVecBase3 &ul, const LVecBase3 &ur, const LVecBase3 &ll, const LVecBase3 &lr, int flags) |
| | Sets up the lens to use the frustum defined by the four indicated points.
|
| void | set_interocular_distance (PN_stdfloat interocular_distance) |
| | Sets the distance between the left and right eyes of a stereo camera.
|
| void | set_keystone (const LVecBase2 &keystone) |
| | Indicates the ratio of keystone correction to perform on the lens, in each of three axes.
|
| void | set_min_fov (PN_stdfloat min_fov) |
| | Sets the field of view of the smallest dimension of the window.
|
| void | set_near (PN_stdfloat near_distance) |
| | Defines the position of the near plane (or cylinder, sphere, whatever).
|
| void | set_near_far (PN_stdfloat near_distance, PN_stdfloat far_distance) |
| | Simultaneously changes the near and far planes.
|
| void | set_view_hpr (PN_stdfloat h, PN_stdfloat p, PN_stdfloat r) |
| | Sets the direction in which the lens is facing.
|
| void | set_view_hpr (const LVecBase3 &view_hpr) |
| | Sets the direction in which the lens is facing.
|
| void | set_view_mat (const LMatrix4 &view_mat) |
| | Sets an arbitrary transformation on the lens.
|
| void | set_view_vector (PN_stdfloat x, PN_stdfloat y, PN_stdfloat z, PN_stdfloat i, PN_stdfloat j, PN_stdfloat k) |
| | Specifies the direction in which the lens is facing by giving an axis to look along, and a perpendicular (or at least non-parallel) up axis.
|
| void | set_view_vector (const LVector3 &view_vector, const LVector3 &up_vector) |
| | Specifies the direction in which the lens is facing by giving an axis to look along, and a perpendicular (or at least non-parallel) up axis.
|
|
virtual void | write (ostream &out, int indent_level=0) const |
| virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
| | Writes the contents of this object to the datagram for shipping out to a Bam file.
|
Static Public Member Functions |
|
static TypeHandle | get_class_type () |
| static PN_stdfloat | get_default_far () |
| | Returns the default far plane distance that will be assigned to each newly-created lens.
|
| static PN_stdfloat | get_default_near () |
| | Returns the default near plane distance that will be assigned to each newly-created lens.
|
|
static void | init_type () |
Protected Types |
|
typedef CycleDataReader< CData > | CDReader |
|
typedef CycleDataWriter< CData > | CDWriter |
| enum | CompFlags {
CF_film_mat = 0x0001,
CF_film_mat_inv = 0x0002,
CF_lens_mat = 0x0004,
CF_lens_mat_inv = 0x0008,
CF_projection_mat = 0x0010,
CF_projection_mat_inv = 0x0020,
CF_projection_mat_left_inv = 0x0040,
CF_projection_mat_right_inv = 0x0080,
CF_mat = 0x00ff,
CF_film_size = 0x0100,
CF_aspect_ratio = 0x0200,
CF_view_hpr = 0x0400,
CF_view_vector = 0x0800,
CF_focal_length = 0x1000,
CF_fov = 0x2000
} |
| enum | UserFlags {
UF_film_width = 0x0001,
UF_film_height = 0x0002,
UF_focal_length = 0x0004,
UF_hfov = 0x0008,
UF_vfov = 0x0010,
UF_aspect_ratio = 0x0020,
UF_view_hpr = 0x0040,
UF_view_vector = 0x0080,
UF_interocular_distance = 0x0100,
UF_convergence_distance = 0x0200,
UF_view_mat = 0x0400,
UF_keystone = 0x0800,
UF_min_fov = 0x1000,
UF_custom_film_mat = 0x2000
} |
Protected Member Functions |
| void | do_adjust_comp_flags (CData *cdata, int clear_flags, int set_flags) |
| | Clears from _comp_flags the bits in the first parameter, and sets the bits in the second parameter.
|
| void | do_adjust_user_flags (CData *cdata, int clear_flags, int set_flags) |
| | Clears from _user_flags the bits in the first parameter, and sets the bits in the second parameter.
|
| virtual void | do_compute_aspect_ratio (CData *cdata) |
| | Computes the aspect ratio of the film rectangle, as a ratio of width to height.
|
| virtual void | do_compute_film_mat (CData *cdata) |
| | Computes the matrix that transforms from a point behind the lens to a point on the film.
|
| virtual void | do_compute_film_size (CData *cdata) |
| | Computes the size and shape of the film behind the camera, based on the aspect ratio and fov.
|
| virtual void | do_compute_focal_length (CData *cdata) |
| | Computes the focal length of the lens, based on the fov and film size.
|
| virtual void | do_compute_fov (CData *cdata) |
| | Computes the field of view of the lens, based on the film size and focal length.
|
| virtual void | do_compute_lens_mat (CData *cdata) |
| | Computes the matrix that transforms from a point in front of the lens to a point in space.
|
| virtual void | do_compute_projection_mat (CData *cdata) |
| | Computes the complete transformation matrix from 3-d point to 2-d point, if the lens is linear.
|
| virtual void | do_compute_view_hpr (CData *cdata) |
| | Computes the Euler angles representing the lens' rotation.
|
| virtual void | do_compute_view_vector (CData *cdata) |
| | Computes the view vector and up vector for the lens.
|
| virtual bool | do_extrude (const CData *cdata, const LPoint3 &point2d, LPoint3 &near_point, LPoint3 &far_point) const |
| | Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the corresponding vector in space that maps to this point, if such a vector can be determined.
|
| virtual bool | do_extrude_depth (const CData *cdata, const LPoint3 &point2d, LPoint3 &point3d) const |
| | This is the generic implementation, which is based on do_extrude() and assumes a linear distribution of depth values between the near and far points.
|
| bool | do_extrude_depth_with_mat (const CData *cdata, const LPoint3 &point2d, LPoint3 &point3d) const |
| | Implements do_extrude_depth() by using the projection matrix.
|
| virtual bool | do_extrude_vec (const CData *cdata, const LPoint3 &point2d, LVector3 &vec) const |
| | Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the vector that corresponds to the view direction.
|
|
PN_stdfloat | do_get_aspect_ratio (const CData *cdata) const |
|
PN_stdfloat | do_get_far (const CData *cdata) const |
|
const LMatrix4 & | do_get_film_mat (const CData *cdata) const |
|
const LMatrix4 & | do_get_film_mat_inv (const CData *cdata) const |
|
const LVector2 & | do_get_film_offset (const CData *cdata) const |
|
const LVecBase2 & | do_get_film_size (const CData *cdata) const |
|
PN_stdfloat | do_get_focal_length (const CData *cdata) const |
|
const LVecBase2 & | do_get_fov (const CData *cdata) const |
|
const LMatrix4 & | do_get_lens_mat (const CData *cdata) const |
|
const LMatrix4 & | do_get_lens_mat_inv (const CData *cdata) const |
|
PN_stdfloat | do_get_near (const CData *cdata) const |
|
const LMatrix4 & | do_get_projection_mat (const CData *cdata, StereoChannel channel=SC_mono) const |
|
const LMatrix4 & | do_get_projection_mat_inv (const CData *cdata, StereoChannel channel=SC_mono) const |
|
const LMatrix4 & | do_get_view_mat (const CData *cdata) const |
| virtual bool | do_project (const CData *cdata, const LPoint3 &point3d, LPoint3 &point2d) const |
| | Given a 3-d point in space, determine the 2-d point this maps to, in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner.
|
|
void | do_set_aspect_ratio (CData *cdata, PN_stdfloat aspect_ratio) |
|
void | do_set_convergence_distance (CData *cdata, PN_stdfloat convergence_distance) |
|
void | do_set_far (CData *cdata, PN_stdfloat far_distance) |
|
void | do_set_film_offset (CData *cdata, const LVecBase2 &film_offset) |
|
void | do_set_film_size (CData *cdata, PN_stdfloat width) |
|
void | do_set_film_size (CData *cdata, const LVecBase2 &film_size) |
|
void | do_set_focal_length (CData *cdata, PN_stdfloat focal_length) |
|
void | do_set_fov (CData *cdata, PN_stdfloat fov) |
|
void | do_set_fov (CData *cdata, const LVecBase2 &fov) |
|
void | do_set_interocular_distance (CData *cdata, PN_stdfloat interocular_distance) |
|
void | do_set_near (CData *cdata, PN_stdfloat near_distance) |
|
void | do_set_near_far (CData *cdata, PN_stdfloat near_distance, PN_stdfloat far_distance) |
|
void | do_set_view_mat (CData *cdata, const LMatrix4 &view_mat) |
| void | do_throw_change_event (CData *cdata) |
| | Throws the event associated with changing properties on this Lens, if any.
|
| void | fillin (DatagramIterator &scan, BamReader *manager) |
| | This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new Lens.
|
| virtual PN_stdfloat | film_to_fov (PN_stdfloat film_size, PN_stdfloat focal_length, bool horiz) const |
| | Given a width (or height) on the film and a focal length, compute the field of view in degrees.
|
| virtual PN_stdfloat | fov_to_film (PN_stdfloat fov, PN_stdfloat focal_length, bool horiz) const |
| | Given a field of view in degrees and a focal length, compute the corresponding width (or height) on the film.
|
| virtual PN_stdfloat | fov_to_focal_length (PN_stdfloat fov, PN_stdfloat film_size, bool horiz) const |
| | Given a field of view in degrees and a width (or height) on the film, compute the focal length of the lens.
|
Protected Attributes |
|
PipelineCycler< CData > | _cycler |
Detailed Description
A base class for any number of different kinds of lenses, linear and otherwise.
Presently, this includes perspective and orthographic lenses.
A Lens object is the main part of a Camera node, which defines the fundamental interface to point-of-view for rendering. Lenses are also used in other contexts, however; for instance, a Spotlight is also defined using a lens.
Definition at line 45 of file lens.h.
Member Function Documentation
Clears from _comp_flags the bits in the first parameter, and sets the bits in the second parameter.
Definition at line 803 of file lens.I.
Referenced by clear_custom_film_mat(), clear_keystone(), MatrixLens::clear_left_eye_mat(), MatrixLens::clear_right_eye_mat(), clear_view_mat(), do_compute_aspect_ratio(), do_compute_film_mat(), do_compute_film_size(), do_compute_focal_length(), do_compute_fov(), do_compute_lens_mat(), PerspectiveLens::do_compute_projection_mat(), OrthographicLens::do_compute_projection_mat(), MatrixLens::do_compute_projection_mat(), do_compute_projection_mat(), do_compute_view_hpr(), do_compute_view_vector(), set_coordinate_system(), set_custom_film_mat(), set_keystone(), MatrixLens::set_left_eye_mat(), set_min_fov(), MatrixLens::set_right_eye_mat(), MatrixLens::set_user_mat(), set_view_hpr(), and set_view_vector().
Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the corresponding vector in space that maps to this point, if such a vector can be determined.
The vector is returned by indicating the points on the near plane and far plane that both map to the indicated 2-d point.
The z coordinate of the 2-d point is ignored.
Returns true if the vector is defined, or false otherwise.
Reimplemented in CylindricalLens, PSphereLens, OSphereLens, and FisheyeLens.
Definition at line 1256 of file lens.cxx.
References LMatrix4f::xform().
Referenced by extrude().
Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the vector that corresponds to the view direction.
This will be parallel to the normal on the surface (the far plane) corresponding to the lens shape at this point.
Generally, for all rational lenses, the center of the film at (0,0) computes a vector that is in the same direction as the vector specified by set_view_vector().
For all linear lenses, including perspective and orthographic lenses, all points on the film compute this same vector (the far plane is a flat plane, so the normal is the same everywhere). For curved lenses like fisheye and cylindrical lenses, different points may compute different vectors (the far "plane" on these lenses is a curved surface).
The z coordinate of the 2-d point is ignored.
Returns true if the vector is defined, or false otherwise.
Reimplemented in CylindricalLens, and FisheyeLens.
Definition at line 1350 of file lens.cxx.
References LVector3f::forward().
Referenced by extrude_vec().
Given a 3-d point in space, determine the 2-d point this maps to, in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner.
The z coordinate will also be set to a value in the range (-1, 1), where -1 represents a point on the near plane, and 1 represents a point on the far plane.
Returns true if the 3-d point is in front of the lens and within the viewing frustum (in which case point2d is filled in), or false otherwise (in which case point2d will be filled in with something, which may or may not be meaningful).
Reimplemented in CylindricalLens, PSphereLens, OSphereLens, and FisheyeLens.
Definition at line 1374 of file lens.cxx.
References LMatrix4f::xform().
Referenced by project().
Throws the event associated with changing properties on this Lens, if any.
Definition at line 1217 of file lens.cxx.
Referenced by clear(), clear_custom_film_mat(), clear_keystone(), clear_view_mat(), set_convergence_distance(), set_coordinate_system(), set_custom_film_mat(), set_interocular_distance(), set_keystone(), set_min_fov(), set_view_hpr(), and set_view_vector().
Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the corresponding vector in space that maps to this point, if such a vector can be determined.
The vector is returned by indicating the points on the near plane and far plane that both map to the indicated 2-d point.
Returns true if the vector is defined, or false otherwise.
Definition at line 32 of file lens.I.
References do_extrude().
Referenced by do_extrude_depth(), PortalClipper::prepare_portal(), CollisionRay::set_from_lens(), and CollisionSegment::set_from_lens().
Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the corresponding vector in space that maps to this point, if such a vector can be determined.
The vector is returned by indicating the points on the near plane and far plane that both map to the indicated 2-d point.
The z coordinate of the 2-d point is ignored.
Returns true if the vector is defined, or false otherwise.
Definition at line 56 of file lens.I.
References do_extrude().
Uses the depth component of the 3-d result from project() to compute the original point in 3-d space corresponding to a particular point on the lens.
This exactly reverses project(), assuming the point does fall legitimately within the lens.
Definition at line 71 of file lens.I.
References do_extrude_depth().
Referenced by PfmVizzer::extrude().
Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the vector that corresponds to the view direction.
This will be parallel to the normal on the surface (the far plane) corresponding to the lens shape at this point.
See the comment block on Lens::extrude_vec_impl() for a more in-depth comment on the meaning of this vector.
Returns true if the vector is defined, or false otherwise.
Definition at line 95 of file lens.I.
References do_extrude_vec().
Given a 2-d point in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner, compute the vector that corresponds to the view direction.
This will be parallel to the normal on the surface (the far plane) corresponding to the lens shape at this point.
See the comment block on Lens::extrude_vec_impl() for a more in-depth comment on the meaning of this vector.
The z coordinate of the 2-d point is ignored.
Returns true if the vector is defined, or false otherwise.
Definition at line 121 of file lens.I.
References do_extrude_vec().
| PN_stdfloat Lens::film_to_fov |
( |
PN_stdfloat |
film_size, |
|
|
PN_stdfloat |
focal_length, |
|
|
bool |
horiz |
|
) |
| const [protected, virtual] |
| PN_stdfloat Lens::fov_to_film |
( |
PN_stdfloat |
fov, |
|
|
PN_stdfloat |
focal_length, |
|
|
bool |
horiz |
|
) |
| const [protected, virtual] |
Returns the aspect ratio of the Lens.
This is determined based on the indicated film size; see set_film_size().
Definition at line 472 of file lens.I.
Returns the name of the event that will be generated whenever any properties of this particular Lens have changed.
Definition at line 199 of file lens.I.
Returns the custom_film_mat specified for the lens.
Definition at line 691 of file lens.I.
Returns the default far plane distance that will be assigned to each newly-created lens.
This is read from the Configrc file.
Definition at line 179 of file lens.cxx.
Returns the default near plane distance that will be assigned to each newly-created lens.
This is read from the Configrc file.
Definition at line 167 of file lens.cxx.
Returns the matrix that transforms from a point behind the lens to a point on the film.
Definition at line 730 of file lens.I.
Returns the matrix that transforms from a point on the film to a point behind the lens.
Definition at line 742 of file lens.I.
Returns the horizontal and vertical film size of the virtual film.
See set_film_size().
Definition at line 291 of file lens.I.
Returns the focal length of the lens.
This may have been set explicitly by a previous call to set_focal_length(), or it may be computed based on the lens' fov and film_size. For certain kinds of lenses, the focal length has no meaning.
Definition at line 363 of file lens.I.
Returns the keystone correction specified for the lens.
Definition at line 679 of file lens.I.
Returns the UpdateSeq that is incremented whenever the lens properties are changed.
As long as this number remains the same, you may assume the lens properties are unchanged.
Definition at line 780 of file lens.I.
Returns the matrix that transforms from a point in front of the lens to a point in space.
Definition at line 754 of file lens.I.
Returns the matrix that transforms from a point in space to a point in front of the lens.
Definition at line 766 of file lens.I.
Returns the matrix that transforms from a 2-d point on the film to a 3-d vector in space, if such a matrix exists.
Definition at line 718 of file lens.I.
Referenced by PfmVizzer::extrude().
Given a 3-d point in space, determine the 2-d point this maps to, in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner.
The z coordinate will also be set to a value in the range (-1, 1), where 1 represents a point on the near plane, and -1 represents a point on the far plane.
Returns true if the 3-d point is in front of the lens and within the viewing frustum (in which case point2d is filled in), or false otherwise (in which case point2d will be filled in with something, which may or may not be meaningful).
Definition at line 168 of file lens.I.
References do_project().
Referenced by PortalClipper::prepare_portal(), and PfmVizzer::project().
Given a 3-d point in space, determine the 2-d point this maps to, in the range (-1,1) in both dimensions, where (0,0) is the center of the lens and (-1,-1) is the lower-left corner.
Returns true if the 3-d point is in front of the lens and within the viewing frustum (in which case point2d is filled in), or false otherwise (in which case point2d will be filled in with something, which may or may not be meaningful).
Definition at line 141 of file lens.I.
References do_project().
Forces all internal parameters of the Lens to be recomputed.
Normally, this should never need to be called; it is provided only to assist in debugging.
Definition at line 601 of file lens.cxx.
Sets the aspect ratio of the lens.
This is the ratio of the height to the width of the generated image. Setting this overrides the two-parameter fov or film size setting.
Definition at line 459 of file lens.I.
Sets the name of the event that will be generated whenever any properties of the Lens have changed.
If this is not set for a particular lens, no event will be generated.
The event is thrown with one parameter, the lens itself. This can be used to automatically track changes to camera fov, etc. in the application.
Definition at line 186 of file lens.I.
Sets the distance between between the camera plane and the point in the distance that the left and right eyes are both looking at.
This distance is used to apply a stereo effect when the lens is rendered on a stereo display region. It only has an effect on a PerspectiveLens.
This parameter must be greater than 0, but may be as large as you like. It controls the amount to which the two eyes are directed inwards towards each other, which is a normal property of stereo vision. It is a distance, not an angle; normally this should be set to the distance from the camera to the area of interest in your scene. If you want to simulate parallel stereo, set this value to a very large number.
Also see set_interocular_distance(), which relates.
Definition at line 623 of file lens.I.
References do_throw_change_event().
Specifies a custom matrix to transform the points on the film after they have been converted into nominal film space (-1 .
. 1 in U and V). This can be used to introduce arbitrary scales, rotations, or other linear transforms to the media plane. This is normally a 2-d matrix, but a full 4x4 matrix may be specified. This is applied on top of any film size, lens shift, and/or keystone correction.
Definition at line 356 of file lens.cxx.
References do_adjust_comp_flags(), do_adjust_user_flags(), do_throw_change_event(), and LMatrix4f::is_nan().
Defines the position of the far plane (or cylinder, sphere, whatever).
Points farther from the lens than this may not be rendered.
Definition at line 510 of file lens.I.
Sets the horizontal and vertical offset amounts of this Lens.
These are both in the same units specified in set_film_size().
This can be used to establish an off-axis lens.
Definition at line 306 of file lens.I.
Sets the horizontal and vertical offset amounts of this Lens.
These are both in the same units specified in set_film_size().
This can be used to establish an off-axis lens.
Definition at line 320 of file lens.I.
Sets the size and shape of the "film" within the lens.
This both establishes the units used by calls like set_focal_length(), and establishes the aspect ratio of the frame.
In a physical camera, the field of view of a lens is determined by the lens' focal length and by the size of the film area exposed by the lens. For instance, a 35mm camera exposes a rectangle on the film about 24mm x 36mm, which means a 50mm lens gives about a 40-degree horizontal field of view.
In the virtual camera, you may set the film size to any units here, and specify a focal length in the same units to simulate the same effect. Or, you may ignore this parameter, and specify the field of view and aspect ratio of the lens directly.
Definition at line 253 of file lens.I.
References set_film_size().
Sets the size and shape of the "film" within the lens.
This both establishes the units used by calls like set_focal_length(), and establishes the aspect ratio of the frame.
In a physical camera, the field of view of a lens is determined by the lens' focal length and by the size of the film area exposed by the lens. For instance, a 35mm camera exposes a rectangle on the film about 24mm x 36mm, which means a 50mm lens gives about a 40-degree horizontal field of view.
In the virtual camera, you may set the film size to any units here, and specify a focal length in the same units to simulate the same effect. Or, you may ignore this parameter, and specify the field of view and aspect ratio of the lens directly.
Definition at line 279 of file lens.I.
Sets the focal length of the lens.
This may adjust the field-of-view correspondingly, and is an alternate way to specify field of view.
For certain kinds of lenses (e.g. OrthographicLens), the focal length has no meaning.
Definition at line 348 of file lens.I.
Sets the horizontal field of view of the lens without changing the aspect ratio.
The vertical field of view is adjusted to maintain the same aspect ratio.
Definition at line 376 of file lens.I.
Referenced by GraphicsOutput::make_cube_map(), and set_fov().
| void Lens::set_fov |
( |
PN_stdfloat |
hfov, |
|
|
PN_stdfloat |
vfov |
|
) |
| [inline] |
Sets the field of view of the lens in both dimensions.
This establishes both the field of view and the aspect ratio of the lens. This is one way to specify the field of view of a lens; set_focal_length() is another way.
For certain kinds of lenses (like OrthoLens), the field of view has no meaning.
Definition at line 394 of file lens.I.
References set_fov().
Sets the field of view of the lens in both dimensions.
This establishes both the field of view and the aspect ratio of the lens. This is one way to specify the field of view of a lens; set_focal_length() is another way.
For certain kinds of lenses (like OrthographicLens), the field of view has no meaning.
Definition at line 411 of file lens.I.
Sets up the lens to use the frustum defined by the four indicated points.
This is most useful for a PerspectiveLens, but it may be called for other kinds of lenses as well.
The frustum will be rooted at the origin (or by whatever translation might have been specified in a previous call to set_view_mat).
It is legal for the four points not to be arranged in a rectangle; if this is the case, the frustum will be fitted as tightly as possible to cover all four points.
The flags parameter contains the union of one or more of the following bits to control the behavior of this function:
FC_roll - If this is included, the camera may be rotated so that its up vector is perpendicular to the top line. Otherwise, the standard up vector is used.
FC_camera_plane - This allows the camera plane to be adjusted to be as nearly perpendicular to the center of the frustum as possible. Without this bit, the orientation camera plane is defined by position of the four points (which should all be coplanar). With this bit, the camera plane is arbitarary, and may be chosen so that the four points do not themselves lie in the camera plane (but the points will still be within the frustum).
FC_off_axis - This allows the resulting frustum to be off-axis to get the tightest possible fit. Without this bit, the viewing axis will be centered within the frustum, but there may be more wasted space along the edges.
FC_aspect_ratio - This allows the frustum to be scaled non-proportionately in the vertical and horizontal dimensions, if necessary, to get a tighter fit. Without this bit, the current aspect ratio will be preserved.
FC_shear - This allows the frustum to be sheared, if necessary, to get the tightest possible fit. This may result in a parallelogram-based frustum, which will give a slanted appearance to the rendered image. Without this bit, the frustum will be rectangle-based.
In general, if 0 is passed in as the value for flags, the generated frustum will be a loose fit but sane; if -1 is passed in, it will be a tighter fit and possibly screwy.
Definition at line 443 of file lens.cxx.
References LMatrix4f::get_row3(), LMatrix4f::ident_mat(), LMatrix4f::invert_affine_from(), LMatrix4f::invert_from(), LVecBase3f::is_nan(), LVecBase3f::length_squared(), LMatrix4f::set_row(), LVector3f::up(), and LMatrix4f::xform_point().
Sets the distance between the left and right eyes of a stereo camera.
This distance is used to apply a stereo effect when the lens is rendered on a stereo display region. It only has an effect on a PerspectiveLens.
The left eye and the right eye are each offset along the X axis by half of this distance, so that this parameter specifies the total distance between them.
Also see set_convergence_distance(), which relates.
Definition at line 583 of file lens.I.
References do_throw_change_event().
Indicates the ratio of keystone correction to perform on the lens, in each of three axes.
This will build a special non-affine scale factor into the projection matrix that will compensate for keystoning of a projected image; this can be used to compensate for a projector that for physical reasons cannot be aimed directly at its screen.
The default value is taken from the default-keystone Config variable. 0, 0 indicates no keystone correction; specify a small value (usually in the range -1 .. 1) in either the x or y position to generate a keystone correction in that axis.
Definition at line 316 of file lens.cxx.
References do_adjust_comp_flags(), do_adjust_user_flags(), do_throw_change_event(), and LVecBase2f::is_nan().
Sets the field of view of the smallest dimension of the window.
If the window is wider than it is tall, this specifies the vertical field of view; if it is taller than it is wide, this specifies the horizontal field of view.
In many cases, this is preferable to setting either the horizontal or vertical field of view explicitly. Setting this parameter means that pulling the window wider will widen the field of view, which is usually what you expect to happen.
Definition at line 113 of file lens.cxx.
References do_adjust_comp_flags(), do_adjust_user_flags(), do_compute_aspect_ratio(), and do_throw_change_event().
Defines the position of the near plane (or cylinder, sphere, whatever).
Points closer to the lens than this may not be rendered.
Definition at line 485 of file lens.I.
Simultaneously changes the near and far planes.
Definition at line 533 of file lens.I.
Sets the direction in which the lens is facing.
Normally, this is down the forward axis (usually the Y axis), but it may be rotated. This is only one way of specifying the rotation; you may also specify an explicit vector in which to look, or you may give a complete transformation matrix.
Definition at line 549 of file lens.I.
Sets an arbitrary transformation on the lens.
This replaces the individual transformation components like set_view_hpr().
Setting a transformation here will have a slightly different effect than putting one on the LensNode that contains this lens. In particular, lighting and other effects computations will still be performed on the lens in its untransformed (facing forward) position, but the actual projection matrix will be transformed by this matrix.
Definition at line 656 of file lens.I.
| void Lens::set_view_vector |
( |
PN_stdfloat |
x, |
|
|
PN_stdfloat |
y, |
|
|
PN_stdfloat |
z, |
|
|
PN_stdfloat |
i, |
|
|
PN_stdfloat |
j, |
|
|
PN_stdfloat |
k |
|
) |
| [inline] |
Specifies the direction in which the lens is facing by giving an axis to look along, and a perpendicular (or at least non-parallel) up axis.
See also set_view_hpr().
Definition at line 563 of file lens.I.
Referenced by PointLight::PointLight().
The documentation for this class was generated from the following files:
| | |