UsdGeomCapsule_1 Class Reference

#include <capsule_1.h>

Inheritance diagram for UsdGeomCapsule_1:

Public Member Functions
	UsdGeomCapsule_1 (const UsdPrim &prim=UsdPrim())
	UsdGeomCapsule_1 (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomCapsule_1 ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetHeightAttr () const
USDGEOM_API UsdAttribute	CreateHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetRadiusTopAttr () const
USDGEOM_API UsdAttribute	CreateRadiusTopAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetRadiusBottomAttr () const
USDGEOM_API UsdAttribute	CreateRadiusBottomAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetAxisAttr () const
USDGEOM_API UsdAttribute	CreateAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetExtentAttr () const
USDGEOM_API UsdAttribute	CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Public Member Functions inherited from UsdGeomGprim
	UsdGeomGprim (const UsdPrim &prim=UsdPrim())
	UsdGeomGprim (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomGprim ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetDisplayColorAttr () const
USDGEOM_API UsdAttribute	CreateDisplayColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetDisplayOpacityAttr () const
USDGEOM_API UsdAttribute	CreateDisplayOpacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetDoubleSidedAttr () const
USDGEOM_API UsdAttribute	CreateDoubleSidedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetOrientationAttr () const
USDGEOM_API UsdAttribute	CreateOrientationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdGeomPrimvar	GetDisplayColorPrimvar () const
USDGEOM_API UsdGeomPrimvar	CreateDisplayColorPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
USDGEOM_API UsdGeomPrimvar	GetDisplayOpacityPrimvar () const
USDGEOM_API UsdGeomPrimvar	CreateDisplayOpacityPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
Public Member Functions inherited from UsdGeomBoundable
	UsdGeomBoundable (const UsdPrim &prim=UsdPrim())
	UsdGeomBoundable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomBoundable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetExtentAttr () const
USDGEOM_API UsdAttribute	CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API bool	ComputeExtent (const UsdTimeCode &time, VtVec3fArray *extent)
Public Member Functions inherited from UsdGeomXformable
	UsdGeomXformable (const UsdPrim &prim=UsdPrim())
	UsdGeomXformable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomXformable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetXformOpOrderAttr () const
USDGEOM_API UsdAttribute	CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdGeomXformOp	AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetXformOp (UsdGeomXformOp::Type const opType, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetTranslateOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetScaleOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateXYZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateXZYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateYXZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateYZXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateZXYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetRotateZYXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetOrientOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	GetTransformOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API bool	SetResetXformStack (bool resetXform) const
USDGEOM_API bool	GetResetXformStack () const
USDGEOM_API bool	SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
USDGEOM_API std::vector < UsdGeomXformOp >	GetOrderedXformOps (bool *resetsXformStack) const
USDGEOM_API bool	ClearXformOpOrder () const
	Clears the local transform stack. More...
USDGEOM_API UsdGeomXformOp	MakeMatrixXform () const
USDGEOM_API bool	TransformMightBeTimeVarying () const
USDGEOM_API bool	TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
USDGEOM_API bool	GetTimeSamples (std::vector< double > *times) const
USDGEOM_API bool	GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
Public Member Functions inherited from UsdGeomImageable
	UsdGeomImageable (const UsdPrim &prim=UsdPrim())
	UsdGeomImageable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomImageable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetVisibilityAttr () const
USDGEOM_API UsdAttribute	CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetPurposeAttr () const
USDGEOM_API UsdAttribute	CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdRelationship	GetProxyPrimRel () const
USDGEOM_API UsdRelationship	CreateProxyPrimRel () const
USDGEOM_API void	MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API void	MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API TfToken	ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
USDGEOM_API UsdAttribute	GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const
USDGEOM_API TfToken	ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API PurposeInfo	ComputePurposeInfo () const
USDGEOM_API PurposeInfo	ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
USDGEOM_API TfToken	ComputePurpose () const
USDGEOM_API UsdPrim	ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
USDGEOM_API bool	SetProxyPrim (const UsdPrim &proxy) const
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
USDGEOM_API GfBBox3d	ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfMatrix4d	ComputeLocalToWorldTransform (UsdTimeCode const &time) const
USDGEOM_API GfMatrix4d	ComputeParentToWorldTransform (UsdTimeCode const &time) const
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API	~UsdTyped ()
	Destructor. More...
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
bool	IsTyped () const
bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...
bool	IsAppliedAPISchema () const
bool	IsMultipleApplyAPISchema () const
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim. More...
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema. More...
virtual USD_API	~UsdSchemaBase ()
	Destructor. More...
USD_API	operator bool () const
UsdPrim	GetPrim () const
	Return this schema object's held prim. More...
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomCapsule_1	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API UsdGeomCapsule_1	Define (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API bool	ComputeExtent (double height, double radiusTop, double radiusBottom, const TfToken &axis, VtVec3fArray *extent)
static USDGEOM_API bool	ComputeExtent (double height, double radiusTop, double radiusBottom, const TfToken &axis, const GfMatrix4d &transform, VtVec3fArray *extent)
Static Public Member Functions inherited from UsdGeomGprim
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomGprim	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdGeomBoundable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomBoundable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API bool	ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent)
static USDGEOM_API bool	ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent)
Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomXformable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API bool	GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
static USDGEOM_API bool	GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
static USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
static USDGEOM_API bool	IsTransformationAffectedByAttrNamed (const TfToken &attrName)
Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomImageable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API const TfTokenVector &	GetOrderedPurposeTokens ()
Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
Static Public Attributes inherited from UsdGeomGprim
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdGeomBoundable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdGeomGprim
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdGeomXformable
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
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

Detailed Description

Defines a primitive capsule, i.e. a cylinder capped by two half spheres, with potentially different radii, centered at the origin, and whose spine is along the specified axis. The spherical cap heights (sagitta) of the two endcaps are a function of the relative radii of the endcaps, such that cylinder tangent and sphere tangent are coincident and maintain C1 continuity.

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.

Definition at line 67 of file capsule_1.h.

Constructor & Destructor Documentation

UsdGeomCapsule_1::UsdGeomCapsule_1 ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a UsdGeomCapsule_1 on UsdPrim prim . Equivalent to UsdGeomCapsule_1::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 79 of file capsule_1.h.

UsdGeomCapsule_1::UsdGeomCapsule_1 ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a UsdGeomCapsule_1 on the prim held by schemaObj . Should be preferred over UsdGeomCapsule_1(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 87 of file capsule_1.h.

virtual USDGEOM_API UsdGeomCapsule_1::~UsdGeomCapsule_1 ( )

virtual

Destructor.

Member Function Documentation

USDGEOM_API UsdSchemaKind UsdGeomCapsule_1::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdGeomBoundable.

static USDGEOM_API bool UsdGeomCapsule_1::ComputeExtent ( double  height, double  radiusTop, double  radiusBottom, const TfToken &  axis, VtVec3fArray *  extent  )

static

Compute the extent for the capsule defined by the height, radiusTop, radiusBottom and axis.

Returns

true upon success, false if unable to calculate extent.

On success, extent will contain an approximate axis-aligned bounding box of the capsule defined by the height, radiusTop, radiusBottom, and axis.

This function is to provide easy authoring of extent for usd authoring tools, hence it is static and acts outside a specific prim (as in attribute based methods).

static USDGEOM_API bool UsdGeomCapsule_1::ComputeExtent ( double  height, double  radiusTop, double  radiusBottom, const TfToken &  axis, const GfMatrix4d &  transform, VtVec3fArray *  extent  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the extent as if the matrix transform was first applied.

USDGEOM_API UsdAttribute UsdGeomCapsule_1::CreateAxisAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetAxisAttr(), and also Usd_Create_Or_Get_Property 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 UsdGeomCapsule_1::CreateExtentAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetExtentAttr(), and also Usd_Create_Or_Get_Property 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 UsdGeomCapsule_1::CreateHeightAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetHeightAttr(), and also Usd_Create_Or_Get_Property 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 UsdGeomCapsule_1::CreateRadiusBottomAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetRadiusBottomAttr(), and also Usd_Create_Or_Get_Property 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 UsdGeomCapsule_1::CreateRadiusTopAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetRadiusTopAttr(), and also Usd_Create_Or_Get_Property 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 USDGEOM_API UsdGeomCapsule_1 UsdGeomCapsule_1::Define ( const UsdStagePtr &  stage, const SdfPath &  path  )

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 USDGEOM_API UsdGeomCapsule_1 UsdGeomCapsule_1::Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a UsdGeomCapsule_1 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:

UsdGeomCapsule_1(stage->GetPrimAtPath(path));

USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetAxisAttr

(

)

const

The axis along which the spine of the capsule is aligned

Declaration	uniform token axis = "Z"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	X, Y, Z

USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetExtentAttr

(

)

const

Extent is re-defined on Capsule only to provide a fallback value.

See Also

UsdGeomGprim::GetExtentAttr().

Declaration	float3[] extent = [(-0.5, -0.5, -1), (0.5, 0.5, 1)]
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Float3Array

USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetHeightAttr

(

)

const

The length of the capsule's spine along the specified axis excluding the size of the two half spheres, i.e. the length of the cylinder portion of the capsule. If you author height you must also author extent.

See Also

GetExtentAttr()

Declaration	double height = 1
C++ Type	double
Usd Type	SdfValueTypeNames->Double

USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetRadiusBottomAttr

(

)

const

The radius of the capping sphere at the bottom of the capsule - i.e. the sphere located in the direction of the negative axis. If you author radius you must also author extent.

See Also

GetExtentAttr()

Declaration	double radiusBottom = 0.5
C++ Type	double
Usd Type	SdfValueTypeNames->Double

USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetRadiusTopAttr

(

)

const

The radius of the capping sphere at the top of the capsule - i.e. the sphere in the direction of the positive axis. If you author radius you must also author extent.

See Also

GetExtentAttr()

Declaration	double radiusTop = 0.5
C++ Type	double
Usd Type	SdfValueTypeNames->Double

static USDGEOM_API const TfTokenVector& UsdGeomCapsule_1::GetSchemaAttributeNames ( bool  includeInherited = true )

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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 151 of file capsule_1.h.

Member Data Documentation

const UsdSchemaKind UsdGeomCapsule_1::schemaKind = UsdSchemaKind::ConcreteTyped

static

Compile time constant representing what kind of schema this class is.

See Also

UsdSchemaKind

Definition at line 73 of file capsule_1.h.

---

The documentation for this class was generated from the following file:

• pxr/usd/usdGeom/capsule_1.h