•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
xformable.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDGEOM_GENERATED_XFORMABLE_H
8#define USDGEOM_GENERATED_XFORMABLE_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdGeom/api.h"
14#include "pxr/usd/usdGeom/imageable.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
17#include "pxr/usd/usdGeom/tokens.h"
18
19#include "pxr/usd/usdGeom/xformOp.h"
20#include <vector>
21
22#include "pxr/base/vt/value.h"
23
24#include "pxr/base/gf/vec3d.h"
25#include "pxr/base/gf/vec3f.h"
26#include "pxr/base/gf/matrix4d.h"
27
28#include "pxr/base/tf/token.h"
29#include "pxr/base/tf/type.h"
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33class SdfAssetPath;
34
35// -------------------------------------------------------------------------- //
36// XFORMABLE //
37// -------------------------------------------------------------------------- //
38
241class UsdGeomXformable : public UsdGeomImageable
242{
243public:
247 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
248
253 explicit UsdGeomXformable(const UsdPrim& prim=UsdPrim())
254 : UsdGeomImageable(prim)
255 {
256 }
257
261 explicit UsdGeomXformable(const UsdSchemaBase& schemaObj)
262 : UsdGeomImageable(schemaObj)
263 {
264 }
265
267 USDGEOM_API
268 virtual ~UsdGeomXformable();
269
273 USDGEOM_API
274 static const TfTokenVector &
275 GetSchemaAttributeNames(bool includeInherited=true);
276
286 USDGEOM_API
287 static UsdGeomXformable
288 Get(const UsdStagePtr &stage, const SdfPath &path);
289
290
291protected:
295 USDGEOM_API
296 UsdSchemaKind _GetSchemaKind() const override;
297
298private:
299 // needs to invoke _GetStaticTfType.
300 friend class UsdSchemaRegistry;
301 USDGEOM_API
302 static const TfType &_GetStaticTfType();
303
304 static bool _IsTypedSchema();
305
306 // override SchemaBase virtuals.
307 USDGEOM_API
308 const TfType &_GetTfType() const override;
309
310public:
311 // --------------------------------------------------------------------- //
312 // XFORMOPORDER
313 // --------------------------------------------------------------------- //
330 USDGEOM_API
331 UsdAttribute GetXformOpOrderAttr() const;
332
338 USDGEOM_API
339 UsdAttribute CreateXformOpOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
340
341public:
342 // ===================================================================== //
343 // Feel free to add custom code below this line, it will be preserved by
344 // the code generator.
345 //
346 // Just remember to:
347 // - Close the class declaration with };
348 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
349 // - Close the include guard with #endif
350 // ===================================================================== //
351 // --(BEGIN CUSTOM CODE)--
352
368 class XformQuery {
369 public:
370 XformQuery():
371 _resetsXformStack(false)
372 { }
373
377 USDGEOM_API
378 XformQuery(const UsdGeomXformable &xformable);
379
382 USDGEOM_API
383 bool GetLocalTransformation(GfMatrix4d *transform,
384 const UsdTimeCode time) const;
385
387 bool GetResetXformStack() const {
388 return _resetsXformStack;
389 }
390
392 USDGEOM_API
393 bool TransformMightBeTimeVarying() const;
394
396 USDGEOM_API
397 bool HasNonEmptyXformOpOrder() const;
398
403 USDGEOM_API
404 bool GetTimeSamples(std::vector<double> *times) const;
405
410 USDGEOM_API
411 bool GetTimeSamplesInInterval(const GfInterval &interval,
412 std::vector<double> *times) const;
413
416 USDGEOM_API
417 bool IsAttributeIncludedInLocalTransform(
418 const TfToken &attrName) const;
419
420 private:
421 // Cached copy of the vector of ordered xform ops.
422 std::vector<UsdGeomXformOp> _xformOps;
423
424 // Cache whether the xformable has !resetsXformStack! in its
425 // xformOpOrder.
426 bool _resetsXformStack;
427 };
428
464 USDGEOM_API
465 UsdGeomXformOp AddXformOp(UsdGeomXformOp::Type const opType,
466 UsdGeomXformOp::Precision const
467 precision=UsdGeomXformOp::PrecisionDouble,
468 TfToken const &opSuffix = TfToken(),
469 bool isInverseOp=false) const;
470
490 USDGEOM_API
491 UsdGeomXformOp GetXformOp(UsdGeomXformOp::Type const opType,
492 TfToken const &opSuffix = TfToken(),
493 bool isInverseOp=false) const;
494
499 USDGEOM_API
500 UsdGeomXformOp AddTranslateXOp(
501 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
502 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
503
508 USDGEOM_API
509 UsdGeomXformOp AddTranslateYOp(
510 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
511 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
512
517 USDGEOM_API
518 UsdGeomXformOp AddTranslateZOp(
519 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
520 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
521
526 USDGEOM_API
527 UsdGeomXformOp AddTranslateOp(
528 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
529 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
530
535 USDGEOM_API
536 UsdGeomXformOp GetTranslateXOp(
537 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
538
543 USDGEOM_API
544 UsdGeomXformOp GetTranslateYOp(
545 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
546
551 USDGEOM_API
552 UsdGeomXformOp GetTranslateZOp(
553 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
554
559 USDGEOM_API
560 UsdGeomXformOp GetTranslateOp(
561 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
562
567 USDGEOM_API
568 UsdGeomXformOp AddScaleXOp(
569 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
570 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
571
576 USDGEOM_API
577 UsdGeomXformOp AddScaleYOp(
578 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
579 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
580
585 USDGEOM_API
586 UsdGeomXformOp AddScaleZOp(
587 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
588 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
589
594 USDGEOM_API
595 UsdGeomXformOp AddScaleOp(
596 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
597 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
598
603 USDGEOM_API
604 UsdGeomXformOp GetScaleXOp(
605 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
606
611 USDGEOM_API
612 UsdGeomXformOp GetScaleYOp(
613 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
614
619 USDGEOM_API
620 UsdGeomXformOp GetScaleZOp(
621 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
622
627 USDGEOM_API
628 UsdGeomXformOp GetScaleOp(
629 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
630
636 USDGEOM_API
637 UsdGeomXformOp AddRotateXOp(
638 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
639 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
640
645 USDGEOM_API
646 UsdGeomXformOp GetRotateXOp(
647 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
648
654 USDGEOM_API
655 UsdGeomXformOp AddRotateYOp(
656 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
657 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
658
663 USDGEOM_API
664 UsdGeomXformOp GetRotateYOp(
665 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
666
671 USDGEOM_API
672 UsdGeomXformOp AddRotateZOp(
673 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
674 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
675
680 USDGEOM_API
681 UsdGeomXformOp GetRotateZOp(
682 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
683
689 USDGEOM_API
690 UsdGeomXformOp AddRotateXYZOp(
691 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
692 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
693
698 USDGEOM_API
699 UsdGeomXformOp GetRotateXYZOp(
700 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
701
707 USDGEOM_API
708 UsdGeomXformOp AddRotateXZYOp(
709 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
710 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
711
716 USDGEOM_API
717 UsdGeomXformOp GetRotateXZYOp(
718 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
719
725 USDGEOM_API
726 UsdGeomXformOp AddRotateYXZOp(
727 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
728 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
729
734 USDGEOM_API
735 UsdGeomXformOp GetRotateYXZOp(
736 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
737
743 USDGEOM_API
744 UsdGeomXformOp AddRotateYZXOp(
745 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
746 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
747
752 USDGEOM_API
753 UsdGeomXformOp GetRotateYZXOp(
754 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
755
761 USDGEOM_API
762 UsdGeomXformOp AddRotateZXYOp(
763 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
764 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
765
770 USDGEOM_API
771 UsdGeomXformOp GetRotateZXYOp(
772 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
773
779 USDGEOM_API
780 UsdGeomXformOp AddRotateZYXOp(
781 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
782 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
783
788 USDGEOM_API
789 UsdGeomXformOp GetRotateZYXOp(
790 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
791
796 USDGEOM_API
797 UsdGeomXformOp AddOrientOp(
798 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
799 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
800
805 USDGEOM_API
806 UsdGeomXformOp GetOrientOp(
807 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
808
818 USDGEOM_API
819 UsdGeomXformOp AddTransformOp(
820 UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
821 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
822
828 USDGEOM_API
829 UsdGeomXformOp GetTransformOp(
830 TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
831
841 USDGEOM_API
842 bool SetResetXformStack(bool resetXform) const;
843
850 USDGEOM_API
851 bool GetResetXformStack() const;
852
874 USDGEOM_API
875 bool SetXformOpOrder(std::vector<UsdGeomXformOp> const &orderedXformOps,
876 bool resetXformStack = false) const;
877
895 USDGEOM_API
896 std::vector<UsdGeomXformOp> GetOrderedXformOps(bool *resetsXformStack) const;
897
899 USDGEOM_API
900 bool ClearXformOpOrder() const;
901
910 USDGEOM_API
911 UsdGeomXformOp MakeMatrixXform() const;
912
919 USDGEOM_API
920 bool TransformMightBeTimeVarying() const;
921
930 USDGEOM_API
931 bool TransformMightBeTimeVarying(
932 const std::vector<UsdGeomXformOp> &ops) const;
933
941 USDGEOM_API
942 bool GetTimeSamples(std::vector<double> *times) const;
943
952 USDGEOM_API
953 bool GetTimeSamplesInInterval(const GfInterval &interval,
954 std::vector<double> *times) const;
955
963 USDGEOM_API
964 static bool GetTimeSamples(
965 std::vector<UsdGeomXformOp> const &orderedXformOps,
966 std::vector<double> *times);
967
976 USDGEOM_API
977 static bool GetTimeSamplesInInterval(
978 std::vector<UsdGeomXformOp> const &orderedXformOps,
979 const GfInterval &interval,
980 std::vector<double> *times);
981
1002 USDGEOM_API
1003 bool GetLocalTransformation(
1004 GfMatrix4d *transform,
1005 bool *resetsXformStack,
1006 const UsdTimeCode time = UsdTimeCode::Default()) const;
1007
1029 USDGEOM_API
1030 bool GetLocalTransformation(GfMatrix4d *transform,
1031 bool *resetsXformStack,
1032 const std::vector<UsdGeomXformOp> &ops,
1033 const UsdTimeCode time = UsdTimeCode::Default()) const;
1034
1047 USDGEOM_API
1048 static bool GetLocalTransformation(GfMatrix4d *transform,
1049 std::vector<UsdGeomXformOp> const &ops,
1050 const UsdTimeCode time);
1051
1054 USDGEOM_API
1055 static bool IsTransformationAffectedByAttrNamed(const TfToken &attrName);
1056
1057private:
1058 // Extracts the value of the xformOpOrder attribute. Returns false if
1059 // the xformOpOrder attribute doesn't exist on the prim (eg. when the prim
1060 // type is incompatible or if it's a pure over).
1061 bool _GetXformOpOrderValue(VtTokenArray *xformOpOrder) const;
1062
1063 // Helper function for getting xformops with or without attribute queries.
1064 std::vector<UsdGeomXformOp>
1065 _GetOrderedXformOps(bool *resetsXformStack,
1066 bool withAttributeQueries) const;
1067};
1068
1069PXR_NAMESPACE_CLOSE_SCOPE
1070
1071#endif
GfInterval
A basic mathematical interval class.
Definition: interval.h:33
GfMatrix4d
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:71
SdfAssetPath
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
SdfPath
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfToken
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
TfType
TfType represents a dynamic runtime type.
Definition: type.h:48
UsdAttribute
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:160
UsdGeomImageable
Base class for all prims that may require rendering or visualization of some sort.
Definition: imageable.h:58
UsdGeomXformOp
Schema wrapper for UsdAttribute for authoring and computing transformation operations,...
Definition: xformOp.h:106
UsdGeomXformOp::Type
Type
Enumerates the set of all transformation operation types.
Definition: xformOp.h:110
UsdGeomXformOp::Precision
Precision
Precision of the encoded transformation operation's value.
Definition: xformOp.h:140
UsdGeomXformOp::PrecisionFloat
@ PrecisionFloat
Floating-point precision.
Definition: xformOp.h:142
UsdGeomXformOp::PrecisionDouble
@ PrecisionDouble
Double precision.
Definition: xformOp.h:141
UsdGeomXformable::XformQuery
Helper class that caches the ordered vector of UsGeomXformOps that contribute to the local transforma...
Definition: xformable.h:368
UsdGeomXformable::XformQuery::GetTimeSamples
USDGEOM_API bool GetTimeSamples(std::vector< double > *times) const
Sets the vector of times at which xformOp samples have been authored in the cached set of xform ops.
UsdGeomXformable::XformQuery::GetLocalTransformation
USDGEOM_API bool GetLocalTransformation(GfMatrix4d *transform, const UsdTimeCode time) const
Utilizes the internally cached UsdAttributeQuery's to efficiently compute the transform value at the ...
UsdGeomXformable::XformQuery::GetTimeSamplesInInterval
USDGEOM_API bool GetTimeSamplesInInterval(const GfInterval &interval, std::vector< double > *times) const
Sets the vector of times in the interval at which xformOp samples have been authored in the cached se...
UsdGeomXformable::XformQuery::GetResetXformStack
bool GetResetXformStack() const
Returns whether the xformable resets its parent's transformation.
Definition: xformable.h:387
UsdGeomXformable::XformQuery::TransformMightBeTimeVarying
USDGEOM_API bool TransformMightBeTimeVarying() const
Returns whether the xform value might change over time.
UsdGeomXformable::XformQuery::HasNonEmptyXformOpOrder
USDGEOM_API bool HasNonEmptyXformOpOrder() const
Returns whether xformOpOrder is non-empty.
UsdGeomXformable::XformQuery::IsAttributeIncludedInLocalTransform
USDGEOM_API bool IsAttributeIncludedInLocalTransform(const TfToken &attrName) const
Returns whether the given attribute affects the local transformation computed for this query.
UsdGeomXformable::XformQuery::XformQuery
USDGEOM_API XformQuery(const UsdGeomXformable &xformable)
Constructs an XformQuery object for the given xformable prim.
UsdGeomXformable
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:242
UsdGeomXformable::GetTimeSamples
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 xformOpOrde...
UsdGeomXformable::CreateXformOpOrderAttr
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.
UsdGeomXformable::GetTransformOp
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.
UsdGeomXformable::AddTransformOp
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.
UsdGeomXformable::ClearXformOpOrder
USDGEOM_API bool ClearXformOpOrder() const
Clears the local transform stack.
UsdGeomXformable::GetRotateZXYOp
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.
UsdGeomXformable::GetTranslateZOp
USDGEOM_API UsdGeomXformOp GetTranslateZOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a translation about the Z-axis from the local stack represented by this xformable.
UsdGeomXformable::AddTranslateYOp
USDGEOM_API UsdGeomXformOp AddTranslateYOp(UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Add a translation about the Y-axis to the local stack represented by this xformable.
UsdGeomXformable::GetScaleOp
USDGEOM_API UsdGeomXformOp GetScaleOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a scale operation from the local stack represented by this xformable.
UsdGeomXformable::AddScaleXOp
USDGEOM_API UsdGeomXformOp AddScaleXOp(UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Add a scale operation about the X-axis to the local stack represented by this xformable.
UsdGeomXformable::AddRotateYZXOp
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.
UsdGeomXformable::AddTranslateXOp
USDGEOM_API UsdGeomXformOp AddTranslateXOp(UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Add a translation about the X-axis to the local stack represented by this xformable.
UsdGeomXformable::GetLocalTransformation
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 o...
UsdGeomXformable::schemaKind
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: xformable.h:247
UsdGeomXformable::GetTranslateXOp
USDGEOM_API UsdGeomXformOp GetTranslateXOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a translation about the X-axis from the local stack represented by this xformable.
UsdGeomXformable::TransformMightBeTimeVarying
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 o...
UsdGeomXformable::GetRotateZOp
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.
UsdGeomXformable::AddScaleZOp
USDGEOM_API UsdGeomXformOp AddScaleZOp(UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Add a scale operation about the Z-axis to the local stack represented by this xformable.
UsdGeomXformable::GetRotateZYXOp
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.
UsdGeomXformable::AddRotateYOp
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.
UsdGeomXformable::SetXformOpOrder
USDGEOM_API bool SetXformOpOrder(std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
Reorder the already-existing transform ops on this prim.
UsdGeomXformable::UsdGeomXformable
UsdGeomXformable(const UsdSchemaBase &schemaObj)
Construct a UsdGeomXformable on the prim held by schemaObj .
Definition: xformable.h:261
UsdGeomXformable::AddScaleOp
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.
UsdGeomXformable::GetTimeSamplesInInterval
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 giv...
UsdGeomXformable::GetScaleZOp
USDGEOM_API UsdGeomXformOp GetScaleZOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a scale operation about the Z-axis from the local stack represented by this xformable.
UsdGeomXformable::AddRotateZYXOp
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.
UsdGeomXformable::GetOrientOp
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.
UsdGeomXformable::AddRotateXZYOp
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.
UsdGeomXformable::GetTimeSamplesInInterval
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 ...
UsdGeomXformable::GetResetXformStack
USDGEOM_API bool GetResetXformStack() const
Does this prim reset its parent's inherited transformation?
UsdGeomXformable::AddRotateZXYOp
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.
UsdGeomXformable::_GetSchemaKind
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdGeomXformable::AddScaleYOp
USDGEOM_API UsdGeomXformOp AddScaleYOp(UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Add a scale operation about the Y-axis to the local stack represented by this xformable.
UsdGeomXformable::AddTranslateOp
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.
UsdGeomXformable::GetSchemaAttributeNames
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 cl...
UsdGeomXformable::GetRotateYXZOp
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.
UsdGeomXformable::AddOrientOp
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.
UsdGeomXformable::GetRotateXYZOp
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.
UsdGeomXformable::~UsdGeomXformable
virtual USDGEOM_API ~UsdGeomXformable()
Destructor.
UsdGeomXformable::MakeMatrixXform
USDGEOM_API UsdGeomXformOp MakeMatrixXform() const
Clears the existing local transform stack and creates a new xform op of type 'transform'.
UsdGeomXformable::GetRotateYOp
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.
UsdGeomXformable::SetResetXformStack
USDGEOM_API bool SetResetXformStack(bool resetXform) const
Specify whether this prim's transform should reset the transformation stack inherited from its parent...
UsdGeomXformable::GetLocalTransformation
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.
UsdGeomXformable::AddRotateZOp
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.
UsdGeomXformable::GetRotateYZXOp
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.
UsdGeomXformable::GetScaleXOp
USDGEOM_API UsdGeomXformOp GetScaleXOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a scale operation about the X-axis from the local stack represented by this xformable.
UsdGeomXformable::GetXformOp
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.
UsdGeomXformable::GetTranslateOp
USDGEOM_API UsdGeomXformOp GetTranslateOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a translate operation from the local stack represented by this xformable.
UsdGeomXformable::GetTimeSamples
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 orderedXformO...
UsdGeomXformable::AddTranslateZOp
USDGEOM_API UsdGeomXformOp AddTranslateZOp(UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Add a translation about the Z-axis to the local stack represented by this xformable.
UsdGeomXformable::AddRotateXYZOp
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.
UsdGeomXformable::AddRotateXOp
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.
UsdGeomXformable::GetScaleYOp
USDGEOM_API UsdGeomXformOp GetScaleYOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a scale operation about the Y-axis from the local stack represented by this xformable.
UsdGeomXformable::AddRotateYXZOp
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.
UsdGeomXformable::GetOrderedXformOps
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 or...
UsdGeomXformable::GetTranslateYOp
USDGEOM_API UsdGeomXformOp GetTranslateYOp(TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
Get a translation about the Y-axis from the local stack represented by this xformable.
UsdGeomXformable::TransformMightBeTimeVarying
USDGEOM_API bool TransformMightBeTimeVarying() const
Determine whether there is any possibility that this prim's local transformation may vary over time.
UsdGeomXformable::Get
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.
UsdGeomXformable::GetLocalTransformation
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 o...
UsdGeomXformable::AddXformOp
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.
UsdGeomXformable::IsTransformationAffectedByAttrNamed
static USDGEOM_API bool IsTransformationAffectedByAttrNamed(const TfToken &attrName)
Returns true if the attribute named attrName could affect the local transformation of an xformable pr...
UsdGeomXformable::GetRotateXOp
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.
UsdGeomXformable::UsdGeomXformable
UsdGeomXformable(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomXformable on UsdPrim prim .
Definition: xformable.h:253
UsdGeomXformable::GetRotateXZYOp
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.
UsdGeomXformable::GetXformOpOrderAttr
USDGEOM_API UsdAttribute GetXformOpOrderAttr() const
Encodes the sequence of transformation operations in the order in which they should be pushed onto a ...
UsdPrim
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
UsdSchemaBase
The base class for all schema types in Usd.
Definition: schemaBase.h:39
UsdSchemaRegistry
Singleton registry that provides access to schema type information and the prim definitions for regis...
Definition: schemaRegistry.h:53
UsdTimeCode
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:67
UsdTimeCode::Default
static constexpr UsdTimeCode Default()
Produce a UsdTimeCode representing the sentinel value for 'default'.
Definition: timeCode.h:95
VtValue
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
UsdSchemaKind
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
token.h
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
TfTokenVector
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440