|
Transformable camera. More...
#include <camera.h>
Public Member Functions | |
UsdGeomCamera (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomCamera on UsdPrim prim . | |
UsdGeomCamera (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomCamera on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomCamera () |
Destructor. | |
USDGEOM_API UsdAttribute | GetProjectionAttr () const |
USDGEOM_API UsdAttribute | CreateProjectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetProjectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetHorizontalApertureAttr () const |
Horizontal aperture in tenths of a scene unit; see Units of Measure for Camera Properties . | |
USDGEOM_API UsdAttribute | CreateHorizontalApertureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetHorizontalApertureAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetVerticalApertureAttr () const |
Vertical aperture in tenths of a scene unit; see Units of Measure for Camera Properties . | |
USDGEOM_API UsdAttribute | CreateVerticalApertureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetVerticalApertureAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetHorizontalApertureOffsetAttr () const |
Horizontal aperture offset in the same units as horizontalAperture. | |
USDGEOM_API UsdAttribute | CreateHorizontalApertureOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetHorizontalApertureOffsetAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetVerticalApertureOffsetAttr () const |
Vertical aperture offset in the same units as verticalAperture. | |
USDGEOM_API UsdAttribute | CreateVerticalApertureOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetVerticalApertureOffsetAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetFocalLengthAttr () const |
Perspective focal length in tenths of a scene unit; see Units of Measure for Camera Properties . | |
USDGEOM_API UsdAttribute | CreateFocalLengthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFocalLengthAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetClippingRangeAttr () const |
Near and far clipping distances in scene units; see Units of Measure for Camera Properties . | |
USDGEOM_API UsdAttribute | CreateClippingRangeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetClippingRangeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetClippingPlanesAttr () const |
Additional, arbitrarily oriented clipping planes. | |
USDGEOM_API UsdAttribute | CreateClippingPlanesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetClippingPlanesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetFStopAttr () const |
Lens aperture. | |
USDGEOM_API UsdAttribute | CreateFStopAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFStopAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetFocusDistanceAttr () const |
Distance from the camera to the focus plane in scene units; see Units of Measure for Camera Properties . | |
USDGEOM_API UsdAttribute | CreateFocusDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFocusDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetStereoRoleAttr () const |
If different from mono, the camera is intended to be the left or right camera of a stereo setup. | |
USDGEOM_API UsdAttribute | CreateStereoRoleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetStereoRoleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetShutterOpenAttr () const |
Frame relative shutter open time in UsdTimeCode units (negative value indicates that the shutter opens before the current frame time). | |
USDGEOM_API UsdAttribute | CreateShutterOpenAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShutterOpenAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetShutterCloseAttr () const |
Frame relative shutter close time, analogous comments from shutter:open apply. | |
USDGEOM_API UsdAttribute | CreateShutterCloseAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetShutterCloseAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetExposureAttr () const |
Exposure adjustment, as a log base-2 value. | |
USDGEOM_API UsdAttribute | CreateExposureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetExposureAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API GfCamera | GetCamera (const UsdTimeCode &time) const |
Creates a GfCamera object from the attribute values at time . | |
USDGEOM_API void | SetFromCamera (const GfCamera &camera, const UsdTimeCode &time) |
Write attribute values from camera for time . | |
Public Member Functions inherited from UsdGeomXformable | |
UsdGeomXformable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomXformable on UsdPrim prim . | |
UsdGeomXformable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomXformable on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomXformable () |
Destructor. | |
USDGEOM_API UsdAttribute | GetXformOpOrderAttr () const |
Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims. | |
USDGEOM_API UsdAttribute | CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetXformOpOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdGeomXformOp | AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add an affine transformation to the local stack represented by this Xformable. | |
USDGEOM_API UsdGeomXformOp | GetXformOp (UsdGeomXformOp::Type const opType, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get an affine transformation from the local stack represented by this Xformable. | |
USDGEOM_API UsdGeomXformOp | AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a translate operation to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetTranslateOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a translate operation from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a scale operation to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetScaleOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a scale operation from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the X-axis to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation about the X-axis from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the Y-axis to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation about the Y-axis from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the Z-axis to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation about the Z-axis from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with XYZ rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateXYZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with XYZ rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with XZY rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateXZYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with XZY rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with YXZ rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateYXZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with YXZ rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with YZX rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateYZXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with YZX rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with ZXY rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateZXYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with ZXY rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with ZYX rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateZYXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with ZYX rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetOrientOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get an orient op (arbitrary axis/angle rotation) from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetTransformOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a tranform op (4x4 matrix transformation) from the local stack represented by this xformable. | |
USDGEOM_API bool | SetResetXformStack (bool resetXform) const |
Specify whether this prim's transform should reset the transformation stack inherited from its parent prim. | |
USDGEOM_API bool | GetResetXformStack () const |
Does this prim reset its parent's inherited transformation? | |
USDGEOM_API bool | SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const |
Reorder the already-existing transform ops on this prim. | |
USDGEOM_API std::vector< UsdGeomXformOp > | GetOrderedXformOps (bool *resetsXformStack) const |
Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order. | |
USDGEOM_API bool | ClearXformOpOrder () const |
Clears the local transform stack. | |
USDGEOM_API UsdGeomXformOp | MakeMatrixXform () const |
Clears the existing local transform stack and creates a new xform op of type 'transform'. | |
USDGEOM_API bool | TransformMightBeTimeVarying () const |
Determine whether there is any possibility that this prim's local transformation may vary over time. | |
USDGEOM_API bool | TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Determine whether there is any possibility that this prim's local transformation may vary over time, using a pre-fetched (cached) list of ordered xform ops supplied by the client. | |
USDGEOM_API bool | GetTimeSamples (std::vector< double > *times) const |
Sets times to the union of all the timesamples at which xformOps that are included in the xformOpOrder attribute are authored. | |
USDGEOM_API bool | GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const |
Sets times to the union of all the timesamples in the interval, interval , at which xformOps that are included in the xformOpOrder attribute are authored. | |
USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const |
Computes the fully-combined, local-to-parent transformation for this prim. | |
USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using a pre-fetched (cached) list of ordered xform ops supplied by the client. | |
Public Member Functions inherited from UsdGeomImageable | |
UsdGeomImageable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomImageable on UsdPrim prim . | |
UsdGeomImageable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomImageable on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomImageable () |
Destructor. | |
USDGEOM_API UsdAttribute | GetVisibilityAttr () const |
Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. | |
USDGEOM_API UsdAttribute | CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetPurposeAttr () const |
Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals. | |
USDGEOM_API UsdAttribute | CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdRelationship | GetProxyPrimRel () const |
The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim. | |
USDGEOM_API UsdRelationship | CreateProxyPrimRel () const |
See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API void | MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
Make the imageable visible if it is invisible at the given time. | |
USDGEOM_API void | MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
Makes the imageable invisible if it is visible at the given time. | |
USDGEOM_API TfToken | ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const |
Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any. | |
USDGEOM_API UsdAttribute | GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const |
Return the attribute that is used for expressing visibility opinions for the given purpose . | |
USDGEOM_API TfToken | ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const |
Calculate the effective purpose visibility of this prim for the given purpose , taking into account opinions for the corresponding purpose attribute, along with overall visibility opinions. | |
USDGEOM_API PurposeInfo | ComputePurposeInfo () const |
Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions. | |
USDGEOM_API PurposeInfo | ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose information about this prim, given the computed purpose information of its parent prim. | |
USDGEOM_API TfToken | ComputePurpose () const |
Calculate the effective purpose information about this prim. | |
USDGEOM_API UsdPrim | ComputeProxyPrim (UsdPrim *renderPrim=NULL) const |
Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel(), or an invalid UsdPrim if this prim has no proxy. | |
USDGEOM_API bool | SetProxyPrim (const UsdPrim &proxy) const |
Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim. | |
USDGEOM_API bool | SetProxyPrim (const UsdSchemaBase &proxy) const |
USDGEOM_API GfBBox3d | ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in world space, at the specified time , and for the specified purposes. | |
USDGEOM_API GfBBox3d | ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in local space, at the specified time , and for the specified purposes. | |
USDGEOM_API GfBBox3d | ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the untransformed bound of this prim, at the specified time , and for the specified purposes. | |
USDGEOM_API GfMatrix4d | ComputeLocalToWorldTransform (UsdTimeCode const &time) const |
Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present. | |
USDGEOM_API GfMatrix4d | ComputeParentToWorldTransform (UsdTimeCode const &time) const |
Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself. | |
Public Member Functions inherited from UsdTyped | |
UsdTyped (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdTyped on UsdPrim prim . | |
UsdTyped (const UsdSchemaBase &schemaObj) | |
Construct a UsdTyped on the prim held by schemaObj . | |
virtual USD_API | ~UsdTyped () |
Destructor. | |
Public Member Functions inherited from UsdSchemaBase | |
bool | IsConcrete () const |
Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. | |
bool | IsTyped () const |
Returns whether or not this class inherits from UsdTyped. | |
bool | IsAPISchema () const |
Returns whether this is an API schema or not. | |
bool | IsAppliedAPISchema () const |
Returns whether this is an applied API schema or not. | |
bool | IsMultipleApplyAPISchema () const |
Returns whether this is an applied API schema or not. | |
UsdSchemaKind | GetSchemaKind () const |
Returns the kind of schema this class is. | |
USD_API | UsdSchemaBase (const UsdPrim &prim=UsdPrim()) |
Construct and store prim as the held prim. | |
USD_API | UsdSchemaBase (const UsdSchemaBase &otherSchema) |
Construct and store for the same prim held by otherSchema . | |
virtual USD_API | ~UsdSchemaBase () |
Destructor. | |
UsdPrim | GetPrim () const |
Return this schema object's held prim. | |
SdfPath | GetPath () const |
Shorthand for GetPrim()->GetPath(). | |
USD_API const UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
Return the prim definition associated with this schema instance if one exists, otherwise return null. | |
USD_API | operator bool () const |
Return true if this schema object is compatible with its held prim, false otherwise. | |
Static Public Member Functions | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomCamera | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomCamera holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API UsdGeomCamera | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. | |
Static Public Member Functions inherited from UsdGeomXformable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomXformable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomXformable holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API bool | GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times) |
Returns the union of all the timesamples at which the attributes belonging to the given orderedXformOps are authored. | |
static USDGEOM_API bool | GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times) |
Returns the union of all the timesamples in the interval at which the attributes belonging to the given orderedXformOps are authored. | |
static USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is a static version of the preceding function that takes a cached list of ordered xform ops. | |
static USDGEOM_API bool | IsTransformationAffectedByAttrNamed (const TfToken &attrName) |
Returns true if the attribute named attrName could affect the local transformation of an xformable prim. | |
Static Public Member Functions inherited from UsdGeomImageable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomImageable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomImageable holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API const TfTokenVector & | GetOrderedPurposeTokens () |
Returns an ordered list of allowed values of the purpose attribute. | |
Static Public Member Functions inherited from UsdTyped | |
static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdTyped holding the prim adhering to this schema at path on stage . | |
Static Public Member Functions inherited from UsdSchemaBase | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdGeomXformable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdGeomImageable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdTyped | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdSchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. | |
Protected Member Functions | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
Protected Member Functions inherited from UsdGeomXformable | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
Protected Member Functions inherited from UsdTyped | |
USD_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
USD_API bool | _IsCompatible () const override |
Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. | |
Protected Member Functions inherited from UsdSchemaBase | |
virtual UsdSchemaKind | _GetSchemaType () const |
const TfType & | _GetType () const |
USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
class | UsdSchemaRegistry |
Transformable camera.
Describes optical properties of a camera via a common set of attributes that provide control over the camera's frustum as well as its depth of field. For stereo, the left and right camera are individual prims tagged through the stereoRole attribute.
There is a corresponding class GfCamera, which can hold the state of a camera (at a particular time). UsdGeomCamera::GetCamera() and UsdGeomCamera::SetFromCamera() convert between a USD camera prim and a GfCamera.
To obtain the camera's location in world space, call the following on a UsdGeomCamera 'camera':
Despite the familiarity of millimeters for specifying some physical camera properties, UsdGeomCamera opts for greater consistency with all other UsdGeom schemas, which measure geometric properties in scene units, as determined by UsdGeomGetStageMetersPerUnit(). We do make a concession, however, in that lens and filmback properties are measured in tenths of a scene unit rather than "raw" scene units. This means that with the fallback value of .01 for metersPerUnit - i.e. scene unit of centimeters - then these "tenth of scene unit" properties are effectively millimeters.
For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdGeomTokens. So to set an attribute to the value "rightHanded", use UsdGeomTokens->rightHanded as the value.
|
inlineexplicit |
Construct a UsdGeomCamera on UsdPrim prim
.
Equivalent to UsdGeomCamera::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
|
inlineexplicit |
Construct a UsdGeomCamera on the prim held by schemaObj
.
Should be preferred over UsdGeomCamera(schemaObj.GetPrim()), as it preserves SchemaBase state.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdTyped.
USDGEOM_API UsdAttribute CreateClippingPlanesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetClippingPlanesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateClippingRangeAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetClippingRangeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateExposureAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetExposureAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateFocalLengthAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFocalLengthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateFocusDistanceAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFocusDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateFStopAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFStopAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateHorizontalApertureAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetHorizontalApertureAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateHorizontalApertureOffsetAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetHorizontalApertureOffsetAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateProjectionAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetProjectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateShutterCloseAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShutterCloseAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateShutterOpenAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetShutterOpenAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateStereoRoleAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetStereoRoleAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateVerticalApertureAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetVerticalApertureAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
USDGEOM_API UsdAttribute CreateVerticalApertureOffsetAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetVerticalApertureOffsetAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path
is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path
is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path
at the current EditTarget. Author SdfPrimSpec s with specifier
== SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a UsdGeomCamera holding the prim adhering to this schema at path
on stage
.
If no prim exists at path
on stage
, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
USDGEOM_API GfCamera GetCamera | ( | const UsdTimeCode & | time | ) | const |
Creates a GfCamera object from the attribute values at time
.
USDGEOM_API UsdAttribute GetClippingPlanesAttr | ( | ) | const |
Additional, arbitrarily oriented clipping planes.
A vector (a,b,c,d) encodes a clipping plane that cuts off (x,y,z) with a * x + b * y + c * z + d * 1 < 0 where (x,y,z) are the coordinates in the camera's space.
Declaration | float4[] clippingPlanes = [] |
C++ Type | VtArray<GfVec4f> |
Usd Type | SdfValueTypeNames->Float4Array |
USDGEOM_API UsdAttribute GetClippingRangeAttr | ( | ) | const |
Near and far clipping distances in scene units; see Units of Measure for Camera Properties .
Declaration | float2 clippingRange = (1, 1000000) |
C++ Type | GfVec2f |
Usd Type | SdfValueTypeNames->Float2 |
USDGEOM_API UsdAttribute GetExposureAttr | ( | ) | const |
Exposure adjustment, as a log base-2 value.
The default of 0.0 has no effect. A value of 1.0 will double the image-plane intensities in a rendered image; a value of -1.0 will halve them.
Declaration | float exposure = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetFocalLengthAttr | ( | ) | const |
Perspective focal length in tenths of a scene unit; see Units of Measure for Camera Properties .
Declaration | float focalLength = 50 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetFocusDistanceAttr | ( | ) | const |
Distance from the camera to the focus plane in scene units; see Units of Measure for Camera Properties .
Declaration | float focusDistance = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetFStopAttr | ( | ) | const |
Lens aperture.
Defaults to 0.0, which turns off focusing.
Declaration | float fStop = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetHorizontalApertureAttr | ( | ) | const |
Horizontal aperture in tenths of a scene unit; see Units of Measure for Camera Properties .
Default is the equivalent of the standard 35mm spherical projector aperture.
Declaration | float horizontalAperture = 20.955 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetHorizontalApertureOffsetAttr | ( | ) | const |
Horizontal aperture offset in the same units as horizontalAperture.
Defaults to 0.
Declaration | float horizontalApertureOffset = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetProjectionAttr | ( | ) | const |
Declaration | token projection = "perspective" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Allowed Values | perspective, orthographic |
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended methods of the schemas involved.
USDGEOM_API UsdAttribute GetShutterCloseAttr | ( | ) | const |
Frame relative shutter close time, analogous comments from shutter:open apply.
A value greater or equal to shutter:open should be authored, otherwise there is no exposure and a renderer should produce a black image.
Declaration | double shutter:close = 0 |
C++ Type | double |
Usd Type | SdfValueTypeNames->Double |
USDGEOM_API UsdAttribute GetShutterOpenAttr | ( | ) | const |
Frame relative shutter open time in UsdTimeCode units (negative value indicates that the shutter opens before the current frame time).
Used for motion blur.
Declaration | double shutter:open = 0 |
C++ Type | double |
Usd Type | SdfValueTypeNames->Double |
USDGEOM_API UsdAttribute GetStereoRoleAttr | ( | ) | const |
If different from mono, the camera is intended to be the left or right camera of a stereo setup.
Declaration | uniform token stereoRole = "mono" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Variability | SdfVariabilityUniform |
Allowed Values | mono, left, right |
USDGEOM_API UsdAttribute GetVerticalApertureAttr | ( | ) | const |
Vertical aperture in tenths of a scene unit; see Units of Measure for Camera Properties .
Default is the equivalent of the standard 35mm spherical projector aperture.
Declaration | float verticalAperture = 15.2908 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API UsdAttribute GetVerticalApertureOffsetAttr | ( | ) | const |
Vertical aperture offset in the same units as verticalAperture.
Defaults to 0.
Declaration | float verticalApertureOffset = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDGEOM_API void SetFromCamera | ( | const GfCamera & | camera, |
const UsdTimeCode & | time | ||
) |
Write attribute values from camera
for time
.
These attributes will be updated:
camera
. This operation will fail if there are stronger xform op opinions in the composed layer stack that are stronger than that of the current edit target.
|
friend |
|
static |
Compile time constant representing what kind of schema this class is.